document wxFSVolume (fixes #3977)

[wxWidgets.git] / interface / wx / dialog.h

diff --git a/interface/wx/dialog.h b/interface/wx/dialog.h
index c76d05b3bc69b0dd7e04283c77a7ba426e7c1607..702595a34c20a131842e722118664013e052a17f 100644 (file)
--- a/interface/wx/dialog.h
+++ b/interface/wx/dialog.h
@@ -167,7 +167,7 @@ public:
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxDEFAULT_DIALOG_STYLE,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = wxDEFAULT_DIALOG_STYLE,

-             const wxString& name = "dialogBox");
+             const wxString& name = wxDialogNameStr);

 
     /**
         Destructor. Deletes any child windows before deleting the physical
 
     /**
         Destructor. Deletes any child windows before deleting the physical


@@ -190,7 +190,7 @@ public:
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */

-    bool CanDoLayoutAdapation();
+    virtual bool CanDoLayoutAdaptation();

 
     /**
         Centres the dialog box on the display.
 
     /**
         Centres the dialog box on the display.


@@ -209,7 +209,7 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_DIALOG_STYLE,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_DIALOG_STYLE,

-                const wxString& name = "dialogBox");
+                const wxString& name = wxDialogNameStr);

 
     /**
         Creates a sizer with standard buttons. @a flags is a bit list of the
 
     /**
         Creates a sizer with standard buttons. @a flags is a bit list of the


@@ -251,7 +251,7 @@ public:
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */

-    bool DoLayoutAdapation();
+    virtual bool DoLayoutAdaptation();

 
     /**
         This function is called when the titlebar OK button is pressed
 
     /**
         This function is called when the titlebar OK button is pressed


@@ -259,6 +259,8 @@ public:
         GetAffirmativeId() is sent by default. You can override this function.
         If the function returns @false, wxWidgets will call Close() for the
         dialog.
         GetAffirmativeId() is sent by default. You can override this function.
         If the function returns @false, wxWidgets will call Close() for the
         dialog.

+
+        @onlyfor{wxmsw}

     */
     virtual bool DoOK();
 
     */
     virtual bool DoOK();
 


@@ -343,7 +345,7 @@ public:
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */
 
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */

-    wxArrayInt GetMainButtonIds();
+    wxArrayInt& GetMainButtonIds();

 
     /**
         Gets the return code for this window.
 
     /**
         Gets the return code for this window.


@@ -362,6 +364,8 @@ public:
         supported.
 
         This function is not available on any other platform.
         supported.
 
         This function is not available on any other platform.

+
+        @onlyfor{wxmsw}

     */
     wxToolBar* GetToolBar() const;
 
     */
     wxToolBar* GetToolBar() const;
 


@@ -378,7 +382,7 @@ public:
                  Iconize(@false) will bring the window to the front, as does
                  Show(@true).
     */
                  Iconize(@false) will bring the window to the front, as does
                  Show(@true).
     */

-    void Iconize(bool iconize);
+    virtual void Iconize(bool iconize = true);

 
     /**
         Returns @true if the dialog box is iconized. Windows only.
 
     /**
         Returns @true if the dialog box is iconized. Windows only.


@@ -386,7 +390,7 @@ public:
         @remarks Always returns @false under Windows since dialogs cannot be
                  iconized.
     */
         @remarks Always returns @false under Windows since dialogs cannot be
                  iconized.
     */

-    bool IsIconized() const;
+    virtual bool IsIconized() const;

 
     /**
         A static function returning @true if layout adaptation is enabled for
 
     /**
         A static function returning @true if layout adaptation is enabled for


@@ -400,9 +404,11 @@ public:
         Returns @true if @a id is in the array of identifiers to be regarded as
         the main buttons for the non-scrolling area of a dialog.
 
         Returns @true if @a id is in the array of identifiers to be regarded as
         the main buttons for the non-scrolling area of a dialog.
 

+        @onlyfor{wxmsw}
+

         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */
         @see @ref overview_dialog_autoscrolling (for more on layout adaptation)
     */

-    bool IsMainButton(wxWindowID& id) const;
+    bool IsMainButtonId(wxWindowID id) const;

 
     /**
         Returns @true if the dialog box is modal, @false otherwise.
 
     /**
         Returns @true if the dialog box is modal, @false otherwise.


@@ -549,7 +555,7 @@ public:
             otherwise the box is hidden. If @false and the dialog is modal,
             control is returned to the calling program.
     */
             otherwise the box is hidden. If @false and the dialog is modal,
             control is returned to the calling program.
     */

-    bool Show(bool show);
+    virtual bool Show(bool show = 1);

 
     /**
         Shows a modal dialog.
 
     /**
         Shows a modal dialog.


@@ -599,13 +605,13 @@ public:
     /**
         Override this to returns @true if adaptation can and should be done.
     */
     /**
         Override this to returns @true if adaptation can and should be done.
     */

-    bool CanDoLayoutAdaptation(wxDialog* dialog);
+    virtual bool CanDoLayoutAdaptation(wxDialog* dialog) = 0;

 
     /**
         Override this to perform layout adaptation, such as making parts of the
         dialog scroll and resizing the dialog to fit the display. Normally this
         function will be called just before the dialog is shown.
     */
 
     /**
         Override this to perform layout adaptation, such as making parts of the
         dialog scroll and resizing the dialog to fit the display. Normally this
         function will be called just before the dialog is shown.
     */

-    bool DoLayoutAdaptation(wxDialog* dialog);
+    virtual bool DoLayoutAdaptation(wxDialog* dialog) = 0;

 };
 
 };