optimization for faster execution: don't use wxString::Replace() all the times a...

[wxWidgets.git] / interface / dialog.h

diff --git a/interface/dialog.h b/interface/dialog.h
index 757cda83050e1b43b7cac912c1d68009841b7351..73543c1f58c3d3761a8f1cb479d7b706c6c0f2bb 100644 (file)
--- a/interface/dialog.h
+++ b/interface/dialog.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dialog.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dialog.h

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

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


@@ -60,8 +60,7 @@
     @library{wxcore}
     @category{cmndlg}
 
     @library{wxcore}
     @category{cmndlg}
 

-    @seealso
-    @ref overview_wxdialogoverview, wxFrame, @ref overview_validatoroverview
+    @see @ref overview_wxdialogoverview, wxFrame, @ref overview_validatoroverview

     "Validator overview"
 */
 class wxDialog : public wxTopLevelWindow
     "Validator overview"
 */
 class wxDialog : public wxTopLevelWindow


@@ -70,7 +69,7 @@ public:
     //@{
     /**
         Constructor.
     //@{
     /**
         Constructor.

-        
+

         @param parent
             Can be @NULL, a frame or another dialog box.
         @param id
         @param parent
             Can be @NULL, a frame or another dialog box.
         @param id


@@ -90,7 +89,7 @@ public:
             Used to associate a name with the window,
             allowing the application user to set Motif resource values for
             individual dialog boxes.
             Used to associate a name with the window,
             allowing the application user to set Motif resource values for
             individual dialog boxes.

-        
+

         @see Create()
     */
     wxDialog();
         @see Create()
     */
     wxDialog();


@@ -126,7 +125,7 @@ public:
 
     /**
         Centres the dialog box on the display.
 
     /**
         Centres the dialog box on the display.

-        
+

         @param direction
             May be wxHORIZONTAL, wxVERTICAL or wxBOTH.
     */
         @param direction
             May be wxHORIZONTAL, wxVERTICAL or wxBOTH.
     */


@@ -201,10 +200,10 @@ public:
     /**
         Ends a modal dialog, passing a value to be returned from the ShowModal()
         invocation.
     /**
         Ends a modal dialog, passing a value to be returned from the ShowModal()
         invocation.

-        
+

         @param retCode
             The value that should be returned by ShowModal.
         @param retCode
             The value that should be returned by ShowModal.

-        
+

         @see ShowModal(), GetReturnCode(), SetReturnCode()
     */
     void EndModal(int retCode);
         @see ShowModal(), GetReturnCode(), SetReturnCode()
     */
     void EndModal(int retCode);


@@ -212,7 +211,7 @@ public:
     /**
         Gets the identifier of the button which works like standard OK button in this
         dialog.
     /**
         Gets the identifier of the button which works like standard OK button in this
         dialog.

-        
+

         @see SetAffirmativeId()
     */
     int GetAffirmativeId() const;
         @see SetAffirmativeId()
     */
     int GetAffirmativeId() const;


@@ -230,7 +229,7 @@ public:
     /**
         Gets the identifier of the button to map presses of @c ESC
         button to.
     /**
         Gets the identifier of the button to map presses of @c ESC
         button to.

-        
+

         @see SetEscapeId()
     */
     int GetEscapeId() const;
         @see SetEscapeId()
     */
     int GetEscapeId() const;


@@ -277,10 +276,10 @@ public:
 
     /**
         Gets the return code for this window.
 
     /**
         Gets the return code for this window.

-        
+

         @remarks A return code is normally associated with a modal dialog, where
                  ShowModal() returns a code to the application.
         @remarks A return code is normally associated with a modal dialog, where
                  ShowModal() returns a code to the application.

-        
+

         @see SetReturnCode(), ShowModal(), EndModal()
     */
     int GetReturnCode();
         @see SetReturnCode(), ShowModal(), EndModal()
     */
     int GetReturnCode();


@@ -296,10 +295,10 @@ public:
 
     /**
         Iconizes or restores the dialog. Windows only.
 
     /**
         Iconizes or restores the dialog. Windows only.

-        
+

         @param iconize
             If @true, iconizes the dialog box; if @false, shows and restores it.
         @param iconize
             If @true, iconizes the dialog box; if @false, shows and restores it.

-        
+

         @remarks Note that in Windows, iconization has no effect since dialog
                  boxes cannot be iconized. However, applications may
                  need to explicitly restore dialog boxes under Motif
         @remarks Note that in Windows, iconization has no effect since dialog
                  boxes cannot be iconized. However, applications may
                  need to explicitly restore dialog boxes under Motif


@@ -311,7 +310,7 @@ public:
 
     /**
         Returns @true if the dialog box is iconized. Windows only.
 
     /**
         Returns @true if the dialog box is iconized. Windows only.

-        
+

         @remarks Always returns @false under Windows since dialogs cannot be
                  iconized.
     */
         @remarks Always returns @false under Windows since dialogs cannot be
                  iconized.
     */


@@ -340,10 +339,10 @@ public:
 
     /**
         The default handler for wxEVT_SYS_COLOUR_CHANGED.
 
     /**
         The default handler for wxEVT_SYS_COLOUR_CHANGED.

-        
+

         @param event
             The colour change event.
         @param event
             The colour change event.

-        
+

         @remarks Changes the dialog's colour to conform to the current settings
                  (Windows only). Add an event table entry for your
                  dialog class if you wish the behaviour to be different
         @remarks Changes the dialog's colour to conform to the current settings
                  (Windows only). Add an event table entry for your
                  dialog class if you wish the behaviour to be different


@@ -351,7 +350,7 @@ public:
                  you do override this function, call wxEvent::Skip to
                  propagate the notification to child windows and
                  controls.
                  you do override this function, call wxEvent::Skip to
                  propagate the notification to child windows and
                  controls.

-        
+

         @see wxSysColourChangedEvent
     */
     void OnSysColourChanged(wxSysColourChangedEvent& event);
         @see wxSysColourChangedEvent
     */
     void OnSysColourChanged(wxSysColourChangedEvent& event);


@@ -366,7 +365,7 @@ public:
         the special OK button in the PocketPC title bar, an event with this id is
         generated.
         By default, the affirmative id is wxID_OK.
         the special OK button in the PocketPC title bar, an event with this id is
         generated.
         By default, the affirmative id is wxID_OK.

-        
+

         @see GetAffirmativeId(), SetEscapeId()
     */
     void SetAffirmativeId(int id);
         @see GetAffirmativeId(), SetEscapeId()
     */
     void SetAffirmativeId(int id);


@@ -388,7 +387,7 @@ public:
 
     /**
         Sets the icon for this dialog.
 
     /**
         Sets the icon for this dialog.

-        
+

         @param icon
             The icon to associate with this dialog.
     */
         @param icon
             The icon to associate with this dialog.
     */


@@ -396,7 +395,7 @@ public:
 
     /**
         Sets the icons for this dialog.
 
     /**
         Sets the icons for this dialog.

-        
+

         @param icons
             The icons to associate with this dialog.
     */
         @param icons
             The icons to associate with this dialog.
     */


@@ -423,7 +422,7 @@ public:
     /**
         Sets the adaptation mode, overriding the global adaptation flag. @a mode may be
         one of the following values:
     /**
         Sets the adaptation mode, overriding the global adaptation flag. @a mode may be
         one of the following values:

-        
+

         See also @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" for
         more on layout adaptation.
     */
         See also @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" for
         more on layout adaptation.
     */


@@ -439,12 +438,12 @@ public:
     static wxDialogLayoutAdapter* SetLayoutAdapter(wxDialogLayoutAdapter* adapter);
 
     /**
     static wxDialogLayoutAdapter* SetLayoutAdapter(wxDialogLayoutAdapter* adapter);
 
     /**

-        @b NB: This function is deprecated and doesn't work for all ports, just use
+        @note This function is deprecated and doesn't work for all ports, just use

         ShowModal() to show a modal dialog instead.
         Allows the programmer to specify whether the dialog box is modal (Show() blocks
         control
         until the dialog is hidden) or modeless (control returns immediately).
         ShowModal() to show a modal dialog instead.
         Allows the programmer to specify whether the dialog box is modal (Show() blocks
         control
         until the dialog is hidden) or modeless (control returns immediately).

-        
+

         @param flag
             If @true, the dialog will be modal, otherwise it will be modeless.
     */
         @param flag
             If @true, the dialog will be modal, otherwise it will be modeless.
     */


@@ -452,26 +451,26 @@ public:
 
     /**
         Sets the return code for this window.
 
     /**
         Sets the return code for this window.

-        
+

         @param retCode
             The integer return code, usually a control identifier.
         @param retCode
             The integer return code, usually a control identifier.

-        
+

         @remarks A return code is normally associated with a modal dialog, where
                  ShowModal() returns a code to the application.
                  The function EndModal() calls SetReturnCode.
         @remarks A return code is normally associated with a modal dialog, where
                  ShowModal() returns a code to the application.
                  The function EndModal() calls SetReturnCode.

-        
+

         @see GetReturnCode(), ShowModal(), EndModal()
     */
     void SetReturnCode(int retCode);
 
     /**
         Hides or shows the dialog.
         @see GetReturnCode(), ShowModal(), EndModal()
     */
     void SetReturnCode(int retCode);
 
     /**
         Hides or shows the dialog.

-        
+

         @param show
             If @true, the dialog box is shown and brought to the front;
             otherwise the box is hidden. If @false and the dialog is
             modal, control is returned to the calling program.
         @param show
             If @true, the dialog box is shown and brought to the front;
             otherwise the box is hidden. If @false and the dialog is
             modal, control is returned to the calling program.

-        
+

         @remarks The preferred way of dismissing a modal dialog is to use
                  EndModal().
     */
         @remarks The preferred way of dismissing a modal dialog is to use
                  EndModal().
     */


@@ -481,13 +480,14 @@ public:
         Shows a modal dialog. Program flow does not return until the dialog has been
         dismissed with
         EndModal().
         Shows a modal dialog. Program flow does not return until the dialog has been
         dismissed with
         EndModal().

-        
+

         @returns The return value is the value set with SetReturnCode().
     */
     int ShowModal();
 };
 
 
         @returns The return value is the value set with SetReturnCode().
     */
     int ShowModal();
 };
 
 

+

 /**
     @class wxDialogLayoutAdapter
     @wxheader{dialog.h}
 /**
     @class wxDialogLayoutAdapter
     @wxheader{dialog.h}


@@ -506,8 +506,7 @@ public:
     @library{wxcore}
     @category{FIXME}
 
     @library{wxcore}
     @category{FIXME}
 

-    @seealso
-    @ref overview_autoscrollingdialogs "Automatic scrolling dialogs"
+    @see @ref overview_autoscrollingdialogs "Automatic scrolling dialogs"

 */
 class wxDialogLayoutAdapter
 {
 */
 class wxDialogLayoutAdapter
 {


@@ -529,3 +528,4 @@ public:
     */
     bool DoLayoutAdaptation(wxDialog* dialog);
 };
     */
     bool DoLayoutAdaptation(wxDialog* dialog);
 };

+