214 lines
6.6 KiB
C
214 lines
6.6 KiB
C
|
/////////////////////////////////////////////////////////////////////////////
|
||
|
|
// Name: wx/msw/notebook.h
|
||
|
|
// Purpose: MSW/GTK compatible notebook (a.k.a. property sheet)
|
||
|
|
// Author: Robert Roebling
|
||
|
|
// Modified by: Vadim Zeitlin for Windows version
|
||
|
|
// Copyright: (c) Julian Smart
|
||
|
|
// Licence: wxWindows licence
|
||
|
|
/////////////////////////////////////////////////////////////////////////////
|
||
|
|
|
||
|
|
#ifndef _NOTEBOOK_H
|
||
|
|
#define _NOTEBOOK_H
|
||
|
|
|
||
|
|
#if wxUSE_NOTEBOOK
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
// headers
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
#include "wx/control.h"
|
||
|
|
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
// wxNotebook
|
||
|
|
// ----------------------------------------------------------------------------
|
||
|
|
|
||
|
|
class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
|
||
|
|
{
|
||
|
|
public:
|
||
|
|
// ctors
|
||
|
|
// -----
|
||
|
|
// default for dynamic class
|
||
|
|
wxNotebook();
|
||
|
|
// the same arguments as for wxControl (@@@ any special styles?)
|
||
|
|
wxNotebook(wxWindow *parent,
|
||
|
|
wxWindowID id,
|
||
|
|
const wxPoint& pos = wxDefaultPosition,
|
||
|
|
const wxSize& size = wxDefaultSize,
|
||
|
|
long style = 0,
|
||
|
|
const wxString& name = wxNotebookNameStr);
|
||
|
|
// Create() function
|
||
|
|
bool Create(wxWindow *parent,
|
||
|
|
wxWindowID id,
|
||
|
|
const wxPoint& pos = wxDefaultPosition,
|
||
|
|
const wxSize& size = wxDefaultSize,
|
||
|
|
long style = 0,
|
||
|
|
const wxString& name = wxNotebookNameStr);
|
||
|
|
virtual ~wxNotebook();
|
||
|
|
|
||
|
|
// accessors
|
||
|
|
// ---------
|
||
|
|
// get number of pages in the dialog
|
||
|
|
virtual size_t GetPageCount() const;
|
||
|
|
|
||
|
|
// set the currently selected page, return the index of the previously
|
||
|
|
// selected one (or wxNOT_FOUND on error)
|
||
|
|
// NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
|
||
|
|
int SetSelection(size_t nPage);
|
||
|
|
|
||
|
|
// changes selected page without sending events
|
||
|
|
int ChangeSelection(size_t nPage);
|
||
|
|
|
||
|
|
// set/get the title of a page
|
||
|
|
bool SetPageText(size_t nPage, const wxString& strText);
|
||
|
|
wxString GetPageText(size_t nPage) const;
|
||
|
|
|
||
|
|
// image list stuff: each page may have an image associated with it. All
|
||
|
|
// the images belong to an image list, so you have to
|
||
|
|
// 1) create an image list
|
||
|
|
// 2) associate it with the notebook
|
||
|
|
// 3) set for each page it's image
|
||
|
|
// associate image list with a control
|
||
|
|
void SetImageList(wxImageList* imageList);
|
||
|
|
|
||
|
|
// sets/returns item's image index in the current image list
|
||
|
|
int GetPageImage(size_t nPage) const;
|
||
|
|
bool SetPageImage(size_t nPage, int nImage);
|
||
|
|
|
||
|
|
// currently it's always 1 because wxGTK doesn't support multi-row
|
||
|
|
// tab controls
|
||
|
|
int GetRowCount() const;
|
||
|
|
|
||
|
|
// control the appearance of the notebook pages
|
||
|
|
// set the size (the same for all pages)
|
||
|
|
void SetPageSize(const wxSize& size);
|
||
|
|
// set the padding between tabs (in pixels)
|
||
|
|
void SetPadding(const wxSize& padding);
|
||
|
|
|
||
|
|
// operations
|
||
|
|
// ----------
|
||
|
|
// remove all pages
|
||
|
|
bool DeleteAllPages();
|
||
|
|
|
||
|
|
// inserts a new page to the notebook (it will be deleted ny the notebook,
|
||
|
|
// don't delete it yourself). If bSelect, this page becomes active.
|
||
|
|
bool InsertPage(size_t nPage,
|
||
|
|
wxNotebookPage *pPage,
|
||
|
|
const wxString& strText,
|
||
|
|
bool bSelect = false,
|
||
|
|
int imageId = NO_IMAGE);
|
||
|
|
|
||
|
|
// Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
|
||
|
|
// style.
|
||
|
|
void SetTabSize(const wxSize& sz);
|
||
|
|
|
||
|
|
// hit test
|
||
|
|
virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
|
||
|
|
|
||
|
|
// calculate the size of the notebook from the size of its page
|
||
|
|
virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
|
||
|
|
|
||
|
|
// callbacks
|
||
|
|
// ---------
|
||
|
|
void OnSize(wxSizeEvent& event);
|
||
|
|
void OnNavigationKey(wxNavigationKeyEvent& event);
|
||
|
|
|
||
|
|
// base class virtuals
|
||
|
|
// -------------------
|
||
|
|
|
||
|
|
virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
|
||
|
|
virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
|
||
|
|
WXWORD pos, WXHWND control);
|
||
|
|
|
||
|
|
#if wxUSE_CONSTRAINTS
|
||
|
|
virtual void SetConstraintSizes(bool recurse = true);
|
||
|
|
virtual bool DoPhase(int nPhase);
|
||
|
|
#endif // wxUSE_CONSTRAINTS
|
||
|
|
|
||
|
|
// Attempts to get colour for UX theme page background
|
||
|
|
wxColour GetThemeBackgroundColour() const;
|
||
|
|
|
||
|
|
// implementation only
|
||
|
|
// -------------------
|
||
|
|
|
||
|
|
#if wxUSE_UXTHEME
|
||
|
|
virtual bool SetBackgroundColour(const wxColour& colour)
|
||
|
|
{
|
||
|
|
if ( !wxNotebookBase::SetBackgroundColour(colour) )
|
||
|
|
return false;
|
||
|
|
|
||
|
|
UpdateBgBrush();
|
||
|
|
|
||
|
|
return true;
|
||
|
|
}
|
||
|
|
|
||
|
|
// draw child background
|
||
|
|
virtual bool MSWPrintChild(WXHDC hDC, wxWindow *win);
|
||
|
|
|
||
|
|
virtual bool MSWHasInheritableBackground() const { return true; }
|
||
|
|
#endif // wxUSE_UXTHEME
|
||
|
|
|
||
|
|
// translate wxWin styles to the Windows ones
|
||
|
|
virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const;
|
||
|
|
|
||
|
|
protected:
|
||
|
|
// common part of all ctors
|
||
|
|
void Init();
|
||
|
|
|
||
|
|
// hides the currently shown page and shows the given one (if not -1) and
|
||
|
|
// updates m_selection accordingly
|
||
|
|
void UpdateSelection(int selNew);
|
||
|
|
|
||
|
|
// remove one page from the notebook, without deleting
|
||
|
|
virtual wxNotebookPage *DoRemovePage(size_t nPage);
|
||
|
|
|
||
|
|
// get the page rectangle for the current notebook size
|
||
|
|
//
|
||
|
|
// returns empty rectangle if an error occurs, do test for it
|
||
|
|
wxRect GetPageSize() const;
|
||
|
|
|
||
|
|
// set the size of the given page to fit in the notebook
|
||
|
|
void AdjustPageSize(wxNotebookPage *page);
|
||
|
|
|
||
|
|
#if wxUSE_UXTHEME
|
||
|
|
// return the themed brush for painting our children
|
||
|
|
virtual WXHBRUSH MSWGetCustomBgBrush() { return m_hbrBackground; }
|
||
|
|
|
||
|
|
// gets the bitmap of notebook background and returns a brush from it
|
||
|
|
WXHBRUSH QueryBgBitmap();
|
||
|
|
|
||
|
|
// creates the brush to be used for drawing the tab control background
|
||
|
|
void UpdateBgBrush();
|
||
|
|
|
||
|
|
// common part of QueryBgBitmap() and MSWPrintChild()
|
||
|
|
//
|
||
|
|
// if child == NULL, draw background for the entire notebook itself
|
||
|
|
bool DoDrawBackground(WXHDC hDC, wxWindow *child = NULL);
|
||
|
|
#endif // wxUSE_UXTHEME
|
||
|
|
|
||
|
|
// these function are only used for reducing flicker on notebook resize and
|
||
|
|
// we don't need to do this for WinCE
|
||
|
|
#ifndef __WXWINCE__
|
||
|
|
void OnEraseBackground(wxEraseEvent& event);
|
||
|
|
void OnPaint(wxPaintEvent& event);
|
||
|
|
|
||
|
|
// true if we have already subclassed our updown control
|
||
|
|
bool m_hasSubclassedUpdown;
|
||
|
|
|
||
|
|
// true if we already refreshed the current page after showing the window
|
||
|
|
bool m_doneUpdateHack;
|
||
|
|
#endif // __WXWINCE__
|
||
|
|
|
||
|
|
#if wxUSE_UXTHEME
|
||
|
|
// background brush used to paint the tab control
|
||
|
|
WXHBRUSH m_hbrBackground;
|
||
|
|
#endif // wxUSE_UXTHEME
|
||
|
|
|
||
|
|
|
||
|
|
DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebook)
|
||
|
|
DECLARE_EVENT_TABLE()
|
||
|
|
};
|
||
|
|
|
||
|
|
#endif // wxUSE_NOTEBOOK
|
||
|
|
|
||
|
|
#endif // _NOTEBOOK_H
|