## wxPropertySheetDialog

This class represents a property sheet dialog: a tabbed dialog for showing settings. It is optimized to show with flat tabs on PocketPC devices.

To use this class, call wxPropertySheetDialog::Create from your own Create function. Then call CreateButtons, and create pages, adding them to the book control. Finally call LayoutDialog.

For example:

    bool MyPropertySheetDialog::Create(...)
    {
        if (!wxPropertySheetDialog::Create(...))
            return false;

        CreateButtons(wxOK|wxCANCEL|wxHELP);

        // Add page
        wxPanel* panel = new wxPanel(GetBookCtrl(), ...);
        GetBookCtrl()->AddPage(panel, wxT("General"));

        LayoutDialog();
        return true;
    }

If necessary, override CreateBookCtrl and AddBookCtrl to create and add a different kind of book control. You would then need to use two-step construction for the dialog.

Derived from

wxDialog
wxWindow
wxEvtHandler
wxObject

Include files

<wx/propdlg.h> <wx/generic/propdlg.h>

Members

wxPropertySheetDialog::wxPropertySheetDialog
wxPropertySheetDialog::AddBookCtrl
wxPropertySheetDialog::Create
wxPropertySheetDialog::CreateBookCtrl
wxPropertySheetDialog::CreateButtons
wxPropertySheetDialog::GetBookCtrl
wxPropertySheetDialog::GetInnerSizer
wxPropertySheetDialog::LayoutDialog
wxPropertySheetDialog::SetBookCtrl
wxPropertySheetDialog::SetInnerSizer

### wxPropertySheetDialog::wxPropertySheetDialog

wxPropertySheetDialog(wxWindow* parent, wxWindowID id, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE, const wxString& name = "dialogBox")

Constructor.

### wxPropertySheetDialog::AddBookCtrl

virtual void AddBookCtrl(wxSizer* sizer)

Override this if you wish to add the book control in a way different from the standard way (for example, using different spacing).

### wxPropertySheetDialog::Create

bool Create(wxWindow* parent, wxWindowID id, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxDEFAULT_DIALOG_STYLE, const wxString& name = "dialogBox")

Call this from your own Create function, before adding buttons and pages.

### wxPropertySheetDialog::CreateBookCtrl

virtual wxBookCtrlBase* CreateBookCtrl()

Override this if you wish to create a different kind of book control; by default, a wxNotebook is created.

### wxPropertySheetDialog::CreateButtons

void CreateButtons(int flags=wxOK|wxCANCEL)

Call this to create the buttons for the dialog. This calls wxDialog::CreateButtonSizer, and the flags are the same. On PocketPC, no buttons are created.

### wxPropertySheetDialog::GetBookCtrl

wxBookCtrlBase* GetBookCtrl() const

Returns the book control that will contain your settings pages.

### wxPropertySheetDialog::GetInnerSizer

wxSizer* GetInnerSizer() const

Returns the inner sizer that contains the book control and button sizer.

### wxPropertySheetDialog::LayoutDialog

void LayoutDialog()

Call this to lay out the dialog. On PocketPC, this does nothing, since the dialog will be shown full-screen, and the layout will be done when the dialog receives a size event.

### wxPropertySheetDialog::SetBookCtrl

void SetBookCtrl(wxBookCtrlBase* bookCtrl)

Sets the book control used for the dialog. You will normally not need to use this.

### wxPropertySheetDialog::SetInnerSizer

void SetInnerSizer(wxSizer* sizer)

Sets the inner sizer that contains the book control and button sizer. You will normally not need to use this.