X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..4a31b0c34f2214ce2633f8a4a0167f01290e5657:/interface/wizard.h?ds=sidebyside diff --git a/interface/wizard.h b/interface/wizard.h index 6d9ba969f6..8225b2f6d9 100644 --- a/interface/wizard.h +++ b/interface/wizard.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wizard.h -// Purpose: documentation for wxWizardPage class +// Purpose: interface of wxWizardPage // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxadv} @category{miscwnd} - @seealso - wxWizard, @ref overview_samplewizard "wxWizard sample" + @see wxWizard, @ref overview_samplewizard "wxWizard sample" */ class wxWizardPage : public wxPanel { @@ -35,7 +34,7 @@ public: instead of the default one for this wizard (note that all bitmaps used should be of the same size). Notice that no other parameters are needed because the wizard will resize and reposition the page anyhow. - + @param parent The parent wizard @param bitmap @@ -53,43 +52,43 @@ public: The only cases when you would want to override this function is if the page bitmap depends dynamically on the user choices, i.e. almost never. */ - wxBitmap GetBitmap(); + wxBitmap GetBitmap() const; /** Get the page which should be shown when the user chooses the @c "Next" button: if @NULL is returned, this button will be disabled. The last page of the wizard will usually return @NULL from here, but the others will not. - + @see GetPrev() */ - wxWizardPage* GetNext(); + wxWizardPage* GetNext() const; /** Get the page which should be shown when the user chooses the @c "Back" button: if @NULL is returned, this button will be disabled. The first page of the wizard will usually return @NULL from here, but the others will not. - + @see GetNext() */ - wxWizardPage* GetPrev(); + wxWizardPage* GetPrev() const; }; + /** @class wxWizardEvent @wxheader{wizard.h} wxWizardEvent class represents an event generated by the - wizard: this event is first sent to the page itself and, + wizard(): this event is first sent to the page itself and, if not processed there, goes up the window hierarchy as usual. @library{wxadv} @category{events} - @seealso - wxWizard, @ref overview_samplewizard "wxWizard sample" + @see wxWizard, @ref overview_samplewizard "wxWizard sample" */ class wxWizardEvent : public wxNotifyEvent { @@ -108,16 +107,17 @@ public: we came from the previous page and @false if we returned from the next one. */ - bool GetDirection(); + bool GetDirection() const; /** Returns the wxWizardPage which was active when this event was generated. */ - wxWizardPage* GetPage(); + wxWizardPage* GetPage() const; }; + /** @class wxWizardPageSimple @wxheader{wizard.h} @@ -134,8 +134,7 @@ public: @library{wxadv} @category{miscwnd} - @seealso - wxWizard, @ref overview_samplewizard "wxWizard sample" + @see wxWizard, @ref overview_samplewizard "wxWizard sample" */ class wxWizardPageSimple : public wxWizardPage { @@ -169,6 +168,7 @@ public: }; + /** @class wxWizard @wxheader{wizard.h} @@ -207,8 +207,7 @@ public: @library{wxadv} @category{cmndlg} - @seealso - wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample" + @see wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample" */ class wxWizard : public wxDialog { @@ -221,7 +220,7 @@ public: parameter in the wxWizard constructor because the wizard will have a predefined default size by default. If you want to change this, you should use the GetPageAreaSizer() function. - + @param parent The parent window, may be @NULL. @param id @@ -252,7 +251,7 @@ public: parameter in the wxWizard constructor because the wizard will have a predefined default size by default. If you want to change this, you should use the GetPageAreaSizer() function. - + @param parent The parent window, may be @NULL. @param id @@ -290,7 +289,7 @@ public: /** Returns the bitmap used for the wizard. */ - const wxBitmap GetBitmap(); + const wxBitmap GetBitmap() const; /** Returns the colour that should be used to fill the area not taken up by the @@ -298,7 +297,7 @@ public: if a non-zero bitmap placement flag has been set. See also SetBitmapPlacement(). */ - const wxColour GetBitmapBackgroundColour(); + const wxColour GetBitmapBackgroundColour() const; /** Returns the flags indicating how the wizard or page bitmap should be expanded @@ -312,7 +311,7 @@ public: Get the current page while the wizard is running. @NULL is returned if RunWizard() is not being executed now. */ - wxWizardPage* GetCurrentPage(); + wxWizardPage* GetCurrentPage() const; /** Returns the minimum width for the bitmap that will be constructed to contain @@ -320,7 +319,7 @@ public: if a non-zero bitmap placement flag has been set. See also SetBitmapPlacement(). */ - int GetMinimumBitmapWidth(); + int GetMinimumBitmapWidth() const; /** Returns pointer to page area sizer. The wizard is laid out using sizers and @@ -350,19 +349,19 @@ public: Adding pages to the page area sizer affects the default border width around page area that can be altered with SetBorder(). */ - virtual wxSizer* GetPageAreaSizer(); + virtual wxSizer* GetPageAreaSizer() const; /** Returns the size available for the pages. */ - wxSize GetPageSize(); + wxSize GetPageSize() const; /** Return @true if this page is not the last one in the wizard. The base class version implements this by calling @ref wxWizardPage::getnext page-GetNext but this could be undesirable if, for example, the pages are created on demand only. - + @see HasPrevPage() */ virtual bool HasNextPage(wxWizardPage* page); @@ -372,7 +371,7 @@ public: class version implements this by calling @ref wxWizardPage::getprev page-GetPrev but this could be undesirable if, for example, the pages are created on demand only. - + @see HasNextPage() */ virtual bool HasPrevPage(wxWizardPage* page); @@ -403,34 +402,34 @@ public: page height. By default, placement is 0 (no expansion is done). @a placement is a bitlist with the following possible values: - + @b wxWIZARD_VALIGN_TOP - + Aligns the bitmap at the top. - + @b wxWIZARD_VALIGN_CENTRE - + Centres the bitmap vertically. - + @b wxWIZARD_VALIGN_BOTTOM - + Aligns the bitmap at the bottom. - + @b wxWIZARD_HALIGN_LEFT - + Left-aligns the bitmap. - + @b wxWIZARD_HALIGN_CENTRE - + Centres the bitmap horizontally. - + @b wxWIZARD_HALIGN_RIGHT - + Right-aligns the bitmap. - + @b wxWIZARD_TILE - - + + See also SetMinimumBitmapWidth(). */ void SetBitmapPlacement(int placement); @@ -471,3 +470,4 @@ public: */ void SetPageSize(const wxSize& sizePage); }; +