1///////////////////////////////////////////////////////////////////////////// 2// Name: wx/generic/propdlg.h 3// Purpose: wxPropertySheetDialog 4// Author: Julian Smart 5// Modified by: 6// Created: 2005-03-12 7// RCS-ID: $Id: propdlg.h 49804 2007-11-10 01:09:42Z VZ $ 8// Copyright: (c) Julian Smart 9// Licence: wxWindows licence 10///////////////////////////////////////////////////////////////////////////// 11 12#ifndef _WX_PROPDLG_H_ 13#define _WX_PROPDLG_H_ 14 15#include "wx/defs.h" 16 17#if wxUSE_BOOKCTRL 18 19#include "wx/dialog.h" 20 21class WXDLLIMPEXP_FWD_CORE wxBookCtrlBase; 22 23//----------------------------------------------------------------------------- 24// wxPropertySheetDialog 25// A platform-independent properties dialog. 26// 27// * on PocketPC, a flat-look 'property sheet' notebook will be used, with 28// no OK/Cancel/Help buttons 29// * on other platforms, a normal notebook will be used, with standard buttons 30// 31// To use this class, call Create from your derived class. 32// Then create pages and add to the book control. Finally call CreateButtons and 33// LayoutDialog. 34// 35// For example: 36// 37// MyPropertySheetDialog::Create(...) 38// { 39// wxPropertySheetDialog::Create(...); 40// 41// // Add page 42// wxPanel* panel = new wxPanel(GetBookCtrl(), ...); 43// GetBookCtrl()->AddPage(panel, wxT("General")); 44// 45// CreateButtons(); 46// LayoutDialog(); 47// } 48// 49// Override CreateBookCtrl and AddBookCtrl to create and add a different 50// kind of book control. 51//----------------------------------------------------------------------------- 52 53// Use the platform default 54#define wxPROPSHEET_DEFAULT 0x0001 55 56// Use a notebook 57#define wxPROPSHEET_NOTEBOOK 0x0002 58 59// Use a toolbook 60#define wxPROPSHEET_TOOLBOOK 0x0004 61 62// Use a choicebook 63#define wxPROPSHEET_CHOICEBOOK 0x0008 64 65// Use a listbook 66#define wxPROPSHEET_LISTBOOK 0x0010 67 68// Use a wxButtonToolBar toolbook 69#define wxPROPSHEET_BUTTONTOOLBOOK 0x0020 70 71// Use a treebook 72#define wxPROPSHEET_TREEBOOK 0x0040 73 74// Shrink dialog to fit current page 75#define wxPROPSHEET_SHRINKTOFIT 0x0100 76 77class WXDLLIMPEXP_ADV wxPropertySheetDialog : public wxDialog 78{ 79public: 80 wxPropertySheetDialog() : wxDialog() { Init(); } 81 82 wxPropertySheetDialog(wxWindow* parent, wxWindowID id, 83 const wxString& title, 84 const wxPoint& pos = wxDefaultPosition, 85 const wxSize& sz = wxDefaultSize, 86 long style = wxDEFAULT_DIALOG_STYLE, 87 const wxString& name = wxDialogNameStr) 88 { 89 Init(); 90 Create(parent, id, title, pos, sz, style, name); 91 } 92 93 bool Create(wxWindow* parent, wxWindowID id, 94 const wxString& title, 95 const wxPoint& pos = wxDefaultPosition, 96 const wxSize& sz = wxDefaultSize, 97 long style = wxDEFAULT_DIALOG_STYLE, 98 const wxString& name = wxDialogNameStr); 99 100//// Accessors 101 102 // Set and get the notebook 103 void SetBookCtrl(wxBookCtrlBase* book) { m_bookCtrl = book; } 104 wxBookCtrlBase* GetBookCtrl() const { return m_bookCtrl; } 105 106 // Set and get the inner sizer 107 void SetInnerSize(wxSizer* sizer) { m_innerSizer = sizer; } 108 wxSizer* GetInnerSizer() const { return m_innerSizer ; } 109 110 // Set and get the book style 111 void SetSheetStyle(long sheetStyle) { m_sheetStyle = sheetStyle; } 112 long GetSheetStyle() const { return m_sheetStyle ; } 113 114 // Set and get the border around the whole dialog 115 void SetSheetOuterBorder(int border) { m_sheetOuterBorder = border; } 116 int GetSheetOuterBorder() const { return m_sheetOuterBorder ; } 117 118 // Set and get the border around the book control only 119 void SetSheetInnerBorder(int border) { m_sheetInnerBorder = border; } 120 int GetSheetInnerBorder() const { return m_sheetInnerBorder ; } 121 122/// Operations 123 124 // Creates the buttons (none on PocketPC) 125 virtual void CreateButtons(int flags = wxOK|wxCANCEL); 126 127 // Lay out the dialog, to be called after pages have been created 128 virtual void LayoutDialog(int centreFlags = wxBOTH); 129 130/// Implementation 131 132 // Creates the book control. If you want to use a different kind of 133 // control, override. 134 virtual wxBookCtrlBase* CreateBookCtrl(); 135 136 // Adds the book control to the inner sizer. 137 virtual void AddBookCtrl(wxSizer* sizer); 138 139 // Set the focus 140 void OnActivate(wxActivateEvent& event); 141 142 // Resize dialog if necessary 143 void OnIdle(wxIdleEvent& event); 144 145private: 146 void Init(); 147 148protected: 149 wxBookCtrlBase* m_bookCtrl; 150 wxSizer* m_innerSizer; // sizer for extra space 151 long m_sheetStyle; 152 int m_sheetOuterBorder; 153 int m_sheetInnerBorder; 154 int m_selectedPage; 155 156 DECLARE_DYNAMIC_CLASS(wxPropertySheetDialog) 157 DECLARE_EVENT_TABLE() 158}; 159 160#endif // wxUSE_BOOKCTRL 161 162#endif // _WX_PROPDLG_H_ 163 164