further prototype revisions; rename interface/aui.h to interface/framemanager.h since...

[wxWidgets.git] / interface / wizard.h

diff --git a/interface/wizard.h b/interface/wizard.h
index bddffa578cb1b849f48628dee183dba52550719c..8225b2f6d9cc43b2569bd557a4287ef9611ca5c0 100644 (file)
--- a/interface/wizard.h
+++ b/interface/wizard.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wizard.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wizard.h

-// Purpose:     documentation for wxWizardPage class
+// Purpose:     interface of wxWizardPage

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -24,8 +24,7 @@
     @library{wxadv}
     @category{miscwnd}
 
     @library{wxadv}
     @category{miscwnd}
 

-    @seealso
-    wxWizard, @ref overview_samplewizard "wxWizard sample"
+    @see wxWizard, @ref overview_samplewizard "wxWizard sample"

 */
 class wxWizardPage : public wxPanel
 {
 */
 class wxWizardPage : public wxPanel
 {


@@ -35,12 +34,11 @@ 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.
         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
         @param parent

-        The parent wizard
-        
+            The parent wizard

         @param bitmap
         @param bitmap

-        The page-specific bitmap if different from the global one
+            The page-specific bitmap if different from the global one

     */
     wxWizardPage(wxWizard* parent,
                  const wxBitmap& bitmap = wxNullBitmap);
     */
     wxWizardPage(wxWizard* parent,
                  const wxBitmap& bitmap = wxNullBitmap);


@@ -49,50 +47,48 @@ public:
         This method is called by wxWizard to get the bitmap to display alongside the
         page. By default, @c m_bitmap member variable which was set in the
         @ref wxwizardpage() constructor.
         This method is called by wxWizard to get the bitmap to display alongside the
         page. By default, @c m_bitmap member variable which was set in the
         @ref wxwizardpage() constructor.

-        

         If the bitmap was not explicitly set (i.e. if @c wxNullBitmap is returned),
         the default bitmap for the wizard should be used.
         If the bitmap was not explicitly set (i.e. if @c wxNullBitmap is returned),
         the default bitmap for the wizard should be used.

-        

         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.
     */
         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.
 
     /**
         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.

-        
-        @sa GetPrev()
+
+        @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.
 
     /**
         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.

-        
-        @sa GetNext()
+
+        @see GetNext()

     */
     */

-    wxWizardPage* GetPrev();
+    wxWizardPage* GetPrev() const;

 };
 
 
 };
 
 

+

 /**
     @class wxWizardEvent
     @wxheader{wizard.h}
 
     wxWizardEvent class represents an event generated by the
 /**
     @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}
 
     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
 {
 */
 class wxWizardEvent : public wxNotifyEvent
 {


@@ -101,8 +97,8 @@ public:
         Constructor. It is not normally used by the user code as the objects of this
         type are constructed by wxWizard.
     */
         Constructor. It is not normally used by the user code as the objects of this
         type are constructed by wxWizard.
     */

-    wxWizardEvent(wxEventType type = wxEVT_@NULL, int id = -1,
-                  bool direction = @true);
+    wxWizardEvent(wxEventType type = wxEVT_NULL, int id = -1,
+                  bool direction = true);

 
     /**
         Return the direction in which the page is changing: for @c
 
     /**
         Return the direction in which the page is changing: for @c


@@ -111,16 +107,17 @@ public:
         we came from the previous page and @false if we returned from the next
         one.
     */
         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.
     */
 
     /**
         Returns the wxWizardPage which was active when this
         event was generated.
     */

-    wxWizardPage* GetPage();
+    wxWizardPage* GetPage() const;

 };
 
 
 };
 
 

+

 /**
     @class wxWizardPageSimple
     @wxheader{wizard.h}
 /**
     @class wxWizardPageSimple
     @wxheader{wizard.h}


@@ -137,8 +134,7 @@ public:
     @library{wxadv}
     @category{miscwnd}
 
     @library{wxadv}
     @category{miscwnd}
 

-    @seealso
-    wxWizard, @ref overview_samplewizard "wxWizard sample"
+    @see wxWizard, @ref overview_samplewizard "wxWizard sample"

 */
 class wxWizardPageSimple : public wxWizardPage
 {
 */
 class wxWizardPageSimple : public wxWizardPage
 {


@@ -148,14 +144,13 @@ public:
         SetPrev() or
         SetNext().
     */
         SetPrev() or
         SetNext().
     */

-    wxWizardPageSimple(wxWizard* parent = @NULL,
-                       wxWizardPage* prev = @NULL,
-                       wxWizardPage* next = @NULL,
+    wxWizardPageSimple(wxWizard* parent = NULL,
+                       wxWizardPage* prev = NULL,
+                       wxWizardPage* next = NULL,

                        const wxBitmap& bitmap = wxNullBitmap);
 
     /**
         A convenience function to make the pages follow each other.
                        const wxBitmap& bitmap = wxNullBitmap);
 
     /**
         A convenience function to make the pages follow each other.

-        

         Example:
     */
     static void Chain(wxWizardPageSimple* first,
         Example:
     */
     static void Chain(wxWizardPageSimple* first,


@@ -173,6 +168,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxWizard
     @wxheader{wizard.h}
 /**
     @class wxWizard
     @wxheader{wizard.h}


@@ -211,8 +207,7 @@ public:
     @library{wxadv}
     @category{cmndlg}
 
     @library{wxadv}
     @category{cmndlg}
 

-    @seealso
-    wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample"
+    @see wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample"

 */
 class wxWizard : public wxDialog
 {
 */
 class wxWizard : public wxDialog
 {


@@ -221,31 +216,25 @@ public:
     /**
         Constructor which really creates the wizard -- if you use this constructor, you
         shouldn't call Create().
     /**
         Constructor which really creates the wizard -- if you use this constructor, you
         shouldn't call Create().

-        

         Notice that unlike almost all other wxWidgets classes, there is no @e size
         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.
         Notice that unlike almost all other wxWidgets classes, there is no @e size
         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
         @param parent

-        The parent window, may be @NULL.
-        
+            The parent window, may be @NULL.

         @param id
         @param id

-        The id of the dialog, will usually be just -1.
-        
+            The id of the dialog, will usually be just -1.

         @param title
         @param title

-        The title of the dialog.
-        
+            The title of the dialog.

         @param bitmap
         @param bitmap

-        The default bitmap used in the left side of the wizard. See
-        also GetBitmap.
-        
+            The default bitmap used in the left side of the wizard. See
+            also GetBitmap.

         @param pos
         @param pos

-        The position of the dialog, it will be centered on the screen
-        by default.
-        
+            The position of the dialog, it will be centered on the screen
+            by default.

         @param style
         @param style

-        Window style is passed to wxDialog.
+            Window style is passed to wxDialog.

     */
     wxWizard();
     wxWizard(wxWindow* parent, int id = -1,
     */
     wxWizard();
     wxWizard(wxWindow* parent, int id = -1,


@@ -258,31 +247,25 @@ public:
     /**
         Creates the wizard dialog. Must be called if the default constructor had been
         used to create the object.
     /**
         Creates the wizard dialog. Must be called if the default constructor had been
         used to create the object.

-        

         Notice that unlike almost all other wxWidgets classes, there is no @e size
         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.
         Notice that unlike almost all other wxWidgets classes, there is no @e size
         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
         @param parent

-        The parent window, may be @NULL.
-        
+            The parent window, may be @NULL.

         @param id
         @param id

-        The id of the dialog, will usually be just -1.
-        
+            The id of the dialog, will usually be just -1.

         @param title
         @param title

-        The title of the dialog.
-        
+            The title of the dialog.

         @param bitmap
         @param bitmap

-        The default bitmap used in the left side of the wizard. See
-        also GetBitmap.
-        
+            The default bitmap used in the left side of the wizard. See
+            also GetBitmap.

         @param pos
         @param pos

-        The position of the dialog, it will be centered on the screen
-        by default.
-        
+            The position of the dialog, it will be centered on the screen
+            by default.

         @param style
         @param style

-        Window style is passed to wxDialog.
+            Window style is passed to wxDialog.

     */
     bool Create(wxWindow* parent, int id = -1,
                 const wxString& title = wxEmptyString,
     */
     bool Create(wxWindow* parent, int id = -1,
                 const wxString& title = wxEmptyString,


@@ -293,10 +276,8 @@ public:
     /**
         This method is obsolete, use
         GetPageAreaSizer() instead.
     /**
         This method is obsolete, use
         GetPageAreaSizer() instead.

-        

         Sets the page size to be big enough for all the pages accessible via the
         given @e firstPage, i.e. this page, its next page and so on.
         Sets the page size to be big enough for all the pages accessible via the
         given @e firstPage, i.e. this page, its next page and so on.

-        

         This method may be called more than once and it will only change the page size
         if the size required by the new page is bigger than the previously set one.
         This is useful if the decision about which pages to show is taken during
         This method may be called more than once and it will only change the page size
         if the size required by the new page is bigger than the previously set one.
         This is useful if the decision about which pages to show is taken during


@@ -308,22 +289,20 @@ public:
     /**
         Returns the bitmap used for the wizard.
     */
     /**
         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
         wizard or page bitmap,
         if a non-zero bitmap placement flag has been set.
 
     /**
         Returns the colour that should be used to fill the area not taken up by the
         wizard or page bitmap,
         if a non-zero bitmap placement flag has been set.

-        

         See also SetBitmapPlacement().
     */
         See also SetBitmapPlacement().
     */

-    const wxColour GetBitmapBackgroundColour();
+    const wxColour GetBitmapBackgroundColour() const;

 
     /**
         Returns the flags indicating how the wizard or page bitmap should be expanded
         and positioned to fit the
         page height. By default, placement is 0 (no expansion is done).
 
     /**
         Returns the flags indicating how the wizard or page bitmap should be expanded
         and positioned to fit the
         page height. By default, placement is 0 (no expansion is done).

-        

         See also SetBitmapPlacement() for the possible values.
     */
     int GetBitmapPlacement();
         See also SetBitmapPlacement() for the possible values.
     */
     int GetBitmapPlacement();


@@ -332,23 +311,21 @@ public:
         Get the current page while the wizard is running. @NULL is returned if
         RunWizard() is not being executed now.
     */
         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
         the actual wizard or page bitmap
         if a non-zero bitmap placement flag has been set.
 
     /**
         Returns the minimum width for the bitmap that will be constructed to contain
         the actual wizard or page bitmap
         if a non-zero bitmap placement flag has been set.

-        

         See also SetBitmapPlacement().
     */
         See also SetBitmapPlacement().
     */

-    int GetMinimumBitmapWidth();
+    int GetMinimumBitmapWidth() const;

 
     /**
         Returns pointer to page area sizer. The wizard is laid out using sizers and
         the page area sizer is the place-holder for the pages. All pages are resized
         before
         being shown to match the wizard page area.
 
     /**
         Returns pointer to page area sizer. The wizard is laid out using sizers and
         the page area sizer is the place-holder for the pages. All pages are resized
         before
         being shown to match the wizard page area.

-        

         Page area sizer has a minimal size that is the maximum of several values. First,
         all pages (or other objects) added to the sizer. Second, all pages reachable
         by repeatedly applying
         Page area sizer has a minimal size that is the maximum of several values. First,
         all pages (or other objects) added to the sizer. Second, all pages reachable
         by repeatedly applying


@@ -359,52 +336,49 @@ public:
         be increased to accommodate the bitmap height. Fifth and finally, wizards are
         never smaller than some built-in minimal size to avoid wizards that are too
         small.
         be increased to accommodate the bitmap height. Fifth and finally, wizards are
         never smaller than some built-in minimal size to avoid wizards that are too
         small.

-        

         The caller can use wxSizer::SetMinSize to enlarge it
         beyond the minimal size. If @c wxRESIZE_BORDER was passed to constructor, user
         can resize wizard and consequently the page area (but not make it smaller than
         the
         minimal size).
         The caller can use wxSizer::SetMinSize to enlarge it
         beyond the minimal size. If @c wxRESIZE_BORDER was passed to constructor, user
         can resize wizard and consequently the page area (but not make it smaller than
         the
         minimal size).

-        

         It is recommended to add the first page to the page area sizer. For simple
         wizards,
         this will enlarge the wizard to fit the biggest page. For non-linear wizards,
         the first page of every separate chain should be added. Caller-specified size
         can be accomplished using wxSizer::SetMinSize.
         It is recommended to add the first page to the page area sizer. For simple
         wizards,
         this will enlarge the wizard to fit the biggest page. For non-linear wizards,
         the first page of every separate chain should be added. Caller-specified size
         can be accomplished using wxSizer::SetMinSize.

-        

         Adding pages to the page area sizer affects the default border width around page
         area that can be altered with SetBorder().
     */
         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.
     */
 
     /**
         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.
 
     /**
         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.

-        
-        @sa HasPrevPage()
+
+        @see HasPrevPage()

     */
     */

-    virtual bool HasNextPage(wxWizardPage * page);
+    virtual bool HasNextPage(wxWizardPage* page);

 
     /**
         Returns @true if this page is not the last one in the wizard. The base
         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.
 
     /**
         Returns @true if this page is not the last one in the wizard. The base
         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.

-        
-        @sa HasNextPage()
+
+        @see HasNextPage()

     */
     */

-    virtual bool HasPrevPage(wxWizardPage * page);
+    virtual bool HasPrevPage(wxWizardPage* page);

 
     /**
         Executes the wizard starting from the given page, returning @true if it was
 
     /**
         Executes the wizard starting from the given page, returning @true if it was

-        successfully finished or @false if user cancelled it. The @e firstPage
+        successfully finished or @false if user cancelled it. The @a firstPage

         can not be @NULL.
     */
     bool RunWizard(wxWizardPage* firstPage);
         can not be @NULL.
     */
     bool RunWizard(wxWizardPage* firstPage);


@@ -418,7 +392,6 @@ public:
         Sets the colour that should be used to fill the area not taken up by the wizard
         or page bitmap,
         if a non-zero bitmap placement flag has been set.
         Sets the colour that should be used to fill the area not taken up by the wizard
         or page bitmap,
         if a non-zero bitmap placement flag has been set.

-        

         See also SetBitmapPlacement().
     */
     void SetBitmapBackgroundColour(const wxColour& colour);
         See also SetBitmapPlacement().
     */
     void SetBitmapBackgroundColour(const wxColour& colour);


@@ -426,44 +399,37 @@ public:
     /**
         Sets the flags indicating how the wizard or page bitmap should be expanded and
         positioned to fit the
     /**
         Sets the flags indicating how the wizard or page bitmap should be expanded and
         positioned to fit the

-        page height. By default, placement is 0 (no expansion is done). @e placement is
+        page height. By default, placement is 0 (no expansion is done). @a placement is

         a bitlist with the
         following possible values:
         a bitlist with the
         following possible values:

-        
+

         @b wxWIZARD_VALIGN_TOP
         @b wxWIZARD_VALIGN_TOP

-        
-        
+

         Aligns the bitmap at the top.
         Aligns the bitmap at the top.

-        
+

         @b wxWIZARD_VALIGN_CENTRE
         @b wxWIZARD_VALIGN_CENTRE

-        
-        
+

         Centres the bitmap vertically.
         Centres the bitmap vertically.

-        
+

         @b wxWIZARD_VALIGN_BOTTOM
         @b wxWIZARD_VALIGN_BOTTOM

-        
-        
+

         Aligns the bitmap at the bottom.
         Aligns the bitmap at the bottom.

-        
+

         @b wxWIZARD_HALIGN_LEFT
         @b wxWIZARD_HALIGN_LEFT

-        
-        
+

         Left-aligns the bitmap.
         Left-aligns the bitmap.

-        
+

         @b wxWIZARD_HALIGN_CENTRE
         @b wxWIZARD_HALIGN_CENTRE

-        
-        
+

         Centres the bitmap horizontally.
         Centres the bitmap horizontally.

-        
+

         @b wxWIZARD_HALIGN_RIGHT
         @b wxWIZARD_HALIGN_RIGHT

-        
-        
+

         Right-aligns the bitmap.
         Right-aligns the bitmap.

-        
+

         @b wxWIZARD_TILE
         @b wxWIZARD_TILE

-        
-        
-        
+
+

         See also SetMinimumBitmapWidth().
     */
     void SetBitmapPlacement(int placement);
         See also SetMinimumBitmapWidth().
     */
     void SetBitmapPlacement(int placement);


@@ -472,7 +438,6 @@ public:
         Sets width of border around page area. Default is zero. For backward
         compatibility, if there are no pages in
         GetPageAreaSizer(), the default is 5 pixels.
         Sets width of border around page area. Default is zero. For backward
         compatibility, if there are no pages in
         GetPageAreaSizer(), the default is 5 pixels.

-        

         If there is a five point border around all controls in a page and the border
         around
         page area is left as zero, a five point white space along all dialog borders
         If there is a five point border around all controls in a page and the border
         around
         page area is left as zero, a five point white space along all dialog borders


@@ -488,7 +453,6 @@ public:
         if a non-zero bitmap placement flag has been set. If this is not set when using
         bitmap placement, the initial
         layout may be incorrect.
         if a non-zero bitmap placement flag has been set. If this is not set when using
         bitmap placement, the initial
         layout may be incorrect.

-        

         See also SetBitmapPlacement().
     */
     void SetMinimumBitmapWidth(int width);
         See also SetBitmapPlacement().
     */
     void SetMinimumBitmapWidth(int width);


@@ -496,11 +460,9 @@ public:
     /**
         This method is obsolete, use
         GetPageAreaSizer() instead.
     /**
         This method is obsolete, use
         GetPageAreaSizer() instead.

-        

         Sets the minimal size to be made available for the wizard pages. The wizard
         will take into account the size of the bitmap (if any) itself. Also, the
         wizard will never be smaller than the default size.
         Sets the minimal size to be made available for the wizard pages. The wizard
         will take into account the size of the bitmap (if any) itself. Also, the
         wizard will never be smaller than the default size.

-        

         The recommended way to use this function is to lay out all wizard pages using
         the sizers (even though the wizard is not resizeable) and then use
         wxSizer::CalcMin in a loop to calculate the maximum
         The recommended way to use this function is to lay out all wizard pages using
         the sizers (even though the wizard is not resizeable) and then use
         wxSizer::CalcMin in a loop to calculate the maximum


@@ -508,3 +470,4 @@ public:
     */
     void SetPageSize(const wxSize& sizePage);
 };
     */
     void SetPageSize(const wxSize& sizePage);
 };

+