/////////////////////////////////////////////////////////////////////////////
// Name: wizard.h
-// Purpose: documentation for wxWizardPage class
+// Purpose: interface of wxWizardPage
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxadv}
@category{miscwnd}
- @seealso
- wxWizard, @ref overview_samplewizard "wxWizard sample"
+ @see wxWizard, @ref overview_samplewizard "wxWizard sample"
*/
class wxWizardPage : public wxPanel
{
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
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
{
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}
@library{wxadv}
@category{miscwnd}
- @seealso
- wxWizard, @ref overview_samplewizard "wxWizard sample"
+ @see wxWizard, @ref overview_samplewizard "wxWizard sample"
*/
class wxWizardPageSimple : public wxWizardPage
{
};
+
/**
@class wxWizard
@wxheader{wizard.h}
@library{wxadv}
@category{cmndlg}
- @seealso
- wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample"
+ @see wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample"
*/
class wxWizard : public wxDialog
{
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
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
/**
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
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
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
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
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);
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);
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);
*/
void SetPageSize(const wxSize& sizePage);
};
+
projects / wxWidgets.git / blobdiff