include/wx/generic/propdlg.h

   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$
   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
  21 class 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
  77 class WXDLLIMPEXP_ADV wxPropertySheetDialog : public wxDialog
  78 {
  79 public:
  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     // Override function in base
 107     virtual wxWindow* GetContentWindow() const;
 108
 109     // Set and get the inner sizer
 110     void SetInnerSize(wxSizer* sizer) { m_innerSizer = sizer; }
 111     wxSizer* GetInnerSizer() const { return m_innerSizer ; }
 112
 113     // Set and get the book style
 114     void SetSheetStyle(long sheetStyle) { m_sheetStyle = sheetStyle; }
 115     long GetSheetStyle() const { return m_sheetStyle ; }
 116
 117     // Set and get the border around the whole dialog
 118     void SetSheetOuterBorder(int border) { m_sheetOuterBorder = border; }
 119     int GetSheetOuterBorder() const { return m_sheetOuterBorder ; }
 120
 121     // Set and get the border around the book control only
 122     void SetSheetInnerBorder(int border) { m_sheetInnerBorder = border; }
 123     int GetSheetInnerBorder() const { return m_sheetInnerBorder ; }
 124
 125 /// Operations
 126
 127     // Creates the buttons (none on PocketPC)
 128     virtual void CreateButtons(int flags = wxOK|wxCANCEL);
 129
 130     // Lay out the dialog, to be called after pages have been created
 131     virtual void LayoutDialog(int centreFlags = wxBOTH);
 132
 133 /// Implementation
 134
 135     // Creates the book control. If you want to use a different kind of
 136     // control, override.
 137     virtual wxBookCtrlBase* CreateBookCtrl();
 138
 139     // Adds the book control to the inner sizer.
 140     virtual void AddBookCtrl(wxSizer* sizer);
 141
 142     // Set the focus
 143     void OnActivate(wxActivateEvent& event);
 144
 145     // Resize dialog if necessary
 146     void OnIdle(wxIdleEvent& event);
 147
 148 private:
 149     void Init();
 150
 151 protected:
 152     wxBookCtrlBase* m_bookCtrl;
 153     wxSizer*        m_innerSizer; // sizer for extra space
 154     long            m_sheetStyle;
 155     int             m_sheetOuterBorder;
 156     int             m_sheetInnerBorder;
 157     int             m_selectedPage;
 158
 159     DECLARE_DYNAMIC_CLASS(wxPropertySheetDialog)
 160     DECLARE_EVENT_TABLE()
 161 };
 162
 163 #endif // wxUSE_BOOKCTRL
 164
 165 #endif // _WX_PROPDLG_H_
 166