Initial review of various [q-r] by Utensil Candel.

[wxWidgets.git] / interface / filepicker.h

diff --git a/interface/filepicker.h b/interface/filepicker.h
index 7f749aacaf27354495527f6082b41dc8deae886f..480c70184759600cfc8fe2259c21d3d63eb4dd4e 100644 (file)
--- a/interface/filepicker.h
+++ b/interface/filepicker.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        filepicker.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        filepicker.h

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

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


@@ -18,35 +18,34 @@
     It is only available if @c wxUSE_FILEPICKERCTRL is set to 1 (the default).
 
     @beginStyleTable
     It is only available if @c wxUSE_FILEPICKERCTRL is set to 1 (the default).
 
     @beginStyleTable

-    @style{wxFLP_DEFAULT_STYLE}:
+    @style{wxFLP_DEFAULT_STYLE}

            The default style: includes wxFLP_OPEN | wxFLP_FILE_MUST_EXIST and,
            under wxMSW only, wxFLP_USE_TEXTCTRL.
            The default style: includes wxFLP_OPEN | wxFLP_FILE_MUST_EXIST and,
            under wxMSW only, wxFLP_USE_TEXTCTRL.

-    @style{wxFLP_USE_TEXTCTRL}:
+    @style{wxFLP_USE_TEXTCTRL}

            Creates a text control to the left of the picker button which is
            completely managed by the wxFilePickerCtrl and which can be used by
            the user to specify a path (see SetPath). The text control is
            automatically synchronized with button's value. Use functions
            defined in wxPickerBase to modify the text control.
            Creates a text control to the left of the picker button which is
            completely managed by the wxFilePickerCtrl and which can be used by
            the user to specify a path (see SetPath). The text control is
            automatically synchronized with button's value. Use functions
            defined in wxPickerBase to modify the text control.

-    @style{wxFLP_OPEN}:
+    @style{wxFLP_OPEN}

            Creates a picker which allows the user to select a file to open.
            Creates a picker which allows the user to select a file to open.

-    @style{wxFLP_SAVE}:
+    @style{wxFLP_SAVE}

            Creates a picker which allows the user to select a file to save.
            Creates a picker which allows the user to select a file to save.

-    @style{wxFLP_OVERWRITE_PROMPT}:
+    @style{wxFLP_OVERWRITE_PROMPT}

            Can be combined with wxFLP_SAVE only: ask confirmation to the user
            before selecting a file.
            Can be combined with wxFLP_SAVE only: ask confirmation to the user
            before selecting a file.

-    @style{wxFLP_FILE_MUST_EXIST}:
+    @style{wxFLP_FILE_MUST_EXIST}

            Can be combined with wxFLP_OPEN only: the selected file must be an
            existing file.
            Can be combined with wxFLP_OPEN only: the selected file must be an
            existing file.

-    @style{wxFLP_CHANGE_DIR}:
+    @style{wxFLP_CHANGE_DIR}

            Change current working directory on each user file selection change.
     @endStyleTable
 
     @library{wxcore}
            Change current working directory on each user file selection change.
     @endStyleTable
 
     @library{wxcore}

-    @category{miscpickers}
-    @appearance{filepickerctrl.png}
+    @category{pickers}
+    <!-- @appearance{filepickerctrl.png} -->

 
 

-    @seealso
-    wxFileDialog, wxFileDirPickerEvent
+    @see wxFileDialog, wxFileDirPickerEvent

 */
 class wxFilePickerCtrl : public wxPickerBase
 {
 */
 class wxFilePickerCtrl : public wxPickerBase
 {


@@ -88,7 +87,7 @@ public:
             Validator which can be used for additional date checks.
         @param name
             Control name.
             Validator which can be used for additional date checks.
         @param name
             Control name.

-        
+

         @returns @true if the control was successfully created or @false if
                  creation failed.
     */
         @returns @true if the control was successfully created or @false if
                  creation failed.
     */


@@ -128,6 +127,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDirPickerCtrl
     @wxheader{filepicker.h}
 /**
     @class wxDirPickerCtrl
     @wxheader{filepicker.h}


@@ -141,30 +141,29 @@ public:
     It is only available if @c wxUSE_DIRPICKERCTRL is set to 1 (the default).
 
     @beginStyleTable
     It is only available if @c wxUSE_DIRPICKERCTRL is set to 1 (the default).
 
     @beginStyleTable

-    @style{wxDIRP_DEFAULT_STYLE}:
+    @style{wxDIRP_DEFAULT_STYLE}

            The default style: includes wxDIRP_DIR_MUST_EXIST and, under wxMSW
            only, wxDIRP_USE_TEXTCTRL.
            The default style: includes wxDIRP_DIR_MUST_EXIST and, under wxMSW
            only, wxDIRP_USE_TEXTCTRL.

-    @style{wxDIRP_USE_TEXTCTRL}:
+    @style{wxDIRP_USE_TEXTCTRL}

            Creates a text control to the left of the picker button which is
            completely managed by the wxDirPickerCtrl and which can be used by
            the user to specify a path (see SetPath). The text control is
            automatically synchronized with button's value. Use functions
            defined in wxPickerBase to modify the text control.
            Creates a text control to the left of the picker button which is
            completely managed by the wxDirPickerCtrl and which can be used by
            the user to specify a path (see SetPath). The text control is
            automatically synchronized with button's value. Use functions
            defined in wxPickerBase to modify the text control.

-    @style{wxDIRP_DIR_MUST_EXIST}:
+    @style{wxDIRP_DIR_MUST_EXIST}

            Creates a picker which allows to select only existing directories.
            wxGTK control always adds this flag internally as it does not
            support its absence.
            Creates a picker which allows to select only existing directories.
            wxGTK control always adds this flag internally as it does not
            support its absence.

-    @style{wxDIRP_CHANGE_DIR}:
+    @style{wxDIRP_CHANGE_DIR}

            Change current working directory on each user directory selection
            change.
     @endStyleTable
 
     @library{wxcore}
            Change current working directory on each user directory selection
            change.
     @endStyleTable
 
     @library{wxcore}

-    @category{miscpickers}
-    @appearance{dirpickerctrl.png}
+    @category{pickers}
+    <!-- @appearance{dirpickerctrl.png} -->

 
 

-    @seealso
-    wxDirDialog, wxFileDirPickerEvent
+    @see wxDirDialog, wxFileDirPickerEvent

 */
 class wxDirPickerCtrl : public wxPickerBase
 {
 */
 class wxDirPickerCtrl : public wxPickerBase
 {


@@ -202,7 +201,7 @@ public:
             Validator which can be used for additional date checks.
         @param name
             Control name.
             Validator which can be used for additional date checks.
         @param name
             Control name.

-        
+

         @returns @true if the control was successfully created or @false if
                  creation failed.
     */
         @returns @true if the control was successfully created or @false if
                  creation failed.
     */


@@ -242,6 +241,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxFileDirPickerEvent
     @wxheader{filepicker.h}
 /**
     @class wxFileDirPickerEvent
     @wxheader{filepicker.h}


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

-    @seealso
-    wxfilepickerctrl
+    @see wxfilepickerctrl()

 */
 class wxFileDirPickerEvent : public wxCommandEvent
 {
 */
 class wxFileDirPickerEvent : public wxCommandEvent
 {


@@ -275,3 +274,4 @@ public:
     */
     void SetPath(const wxString& path);
 };
     */
     void SetPath(const wxString& path);
 };

+