mac paths updated

[wxWidgets.git] / interface / filectrl.h

diff --git a/interface/filectrl.h b/interface/filectrl.h
index a24a4822a0225f067b400662d8169428792cbadb..dfbc38219241ffd46432ef346386406dca343062 100644 (file)
--- a/interface/filectrl.h
+++ b/interface/filectrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        filectrl.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        filectrl.h

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

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


@@ -10,37 +10,52 @@
     @class wxFileCtrl
     @wxheader{filectrl.h}
 
     @class wxFileCtrl
     @wxheader{filectrl.h}
 

-    This control allows the user to select a file. two implemetations exist, one
-    for Gtk and another generic one for anything other than Gtk.
-    It is only available if @c wxUSE_FILECTRL is set to 1.
+    This control allows the user to select a file.
+
+    Two implemetations exist, one for Gtk and another generic one for anything
+    other than Gtk. It is only available if @c wxUSE_FILECTRL is set to 1.

 
     @beginStyleTable
 
     @beginStyleTable

-    @style{wxFC_DEFAULT_STYLE}:
+    @style{wxFC_DEFAULT_STYLE}

            The default style: wxFC_OPEN
            The default style: wxFC_OPEN

-    @style{wxFC_OPEN}:
+    @style{wxFC_OPEN}

            Creates an file control suitable for opening files. Cannot be
            combined with wxFC_SAVE.
            Creates an file control suitable for opening files. Cannot be
            combined with wxFC_SAVE.

-    @style{wxFC_SAVE}:
+    @style{wxFC_SAVE}

            Creates an file control suitable for saving files. Cannot be
            combined with wxFC_OPEN.
            Creates an file control suitable for saving files. Cannot be
            combined with wxFC_OPEN.

-    @style{wxFC_MULTIPLE}:
+    @style{wxFC_MULTIPLE}

            For open control only, Allows selecting multiple files. Cannot be
            combined with wxFC_SAVE
            For open control only, Allows selecting multiple files. Cannot be
            combined with wxFC_SAVE

-    @style{wxFC_NOSHOWHIDDEN}:
+    @style{wxFC_NOSHOWHIDDEN}

            Hides the "Show Hidden Files" checkbox (Generic only)
     @endStyleTable
 
            Hides the "Show Hidden Files" checkbox (Generic only)
     @endStyleTable
 

+
+    @beginEventTable{wxFileCtrlEvent}
+    @event{EVT_FILECTRL_FILEACTIVATED(id, func)}
+        The user activated a file(by double-clicking or pressing Enter)
+    @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)}
+        The user changed the current selection(by selecting or deselecting a file)
+    @event{EVT_FILECTRL_FOLDERCHANGED(id, func)}
+        The current folder of the file control has been changed
+    @endEventTable
+
+    @nativeimpl{gtk}
+

     @library{wxbase}
     @library{wxbase}

-    @category{FIXME}
+    @category{miscwnd}

 
 

-    @seealso
-    wxGenericDirCtrl
+    @see wxGenericDirCtrl

 */
 class wxFileCtrl : public wxWindow
 {
 public:
 */
 class wxFileCtrl : public wxWindow
 {
 public:

-    //@{
+    wxFileCtrl();
+

     /**
     /**

+        Constructs the window.
+

         @param parent
             Parent window, must not be non-@NULL.
         @param id
         @param parent
             Parent window, must not be non-@NULL.
         @param id


@@ -62,11 +77,11 @@ public:
             Initial size.
         @param name
             Control name.
             Initial size.
         @param name
             Control name.

-        
-        @returns @true if the control was successfully created or @false if
+
+        @return @true if the control was successfully created or @false if

                  creation failed.
     */
                  creation failed.
     */

-    wxFileCtrl();
+

     wxFileCtrl(wxWindow* parent, wxWindowID id,
                const wxString& defaultDirectory = wxEmptyString,
                const wxString& defaultFilename = wxEmptyString,
     wxFileCtrl(wxWindow* parent, wxWindowID id,
                const wxString& defaultDirectory = wxEmptyString,
                const wxString& defaultFilename = wxEmptyString,


@@ -75,7 +90,6 @@ public:
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                const wxString& name = "filectrl");
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                const wxString& name = "filectrl");

-    //@}

 
     /**
         Create function for two-step construction. See wxFileCtrl() for details.
 
     /**
         Create function for two-step construction. See wxFileCtrl() for details.


@@ -90,65 +104,64 @@ public:
                 const wxString& name = "filectrl");
 
     /**
                 const wxString& name = "filectrl");
 
     /**

-        Returns the current directory of the file control (i.e. the directory shown by
-        it).
+        Returns the current directory of the file control (i.e. the directory shown by it).

     */
     */

-    wxString GetDirectory();
+    wxString GetDirectory() const;

 
     /**
         Returns the currently selected filename.
 
     /**
         Returns the currently selected filename.

-        For the controls having the @c wxFC_MULTIPLE style, use GetFilenames()
-        instead
+
+        For the controls having the @c wxFC_MULTIPLE style, use GetFilenames() instead.

     */
     */

-    wxString GetFilename();
+    wxString GetFilename() const;

 
     /**
 
     /**

-        Fills the array @a filenames with the filenames only of selected items. This
-        function should only be used with the controls having the @c wxFC_MULTIPLE
-        style,
-        use GetFilename() for the others.
-        
+        Fills the array @a filenames with the filenames only of selected items.
+
+        This function should only be used with the controls having the @c wxFC_MULTIPLE
+        style, use GetFilename() for the others.
+

         @remarks filenames is emptied first.
     */
         @remarks filenames is emptied first.
     */

-    void GetFilenames(wxArrayString& filenames);
+    void GetFilenames(wxArrayString& filenames) const;

 
     /**
         Returns the zero-based index of the currently selected filter.
     */
 
     /**
         Returns the zero-based index of the currently selected filter.
     */

-    int GetFilterIndex();
+    int GetFilterIndex() const;

 
     /**
         Returns the full path (directory and filename) of the currently selected file.
 
     /**
         Returns the full path (directory and filename) of the currently selected file.

-        For the controls having the @c wxFC_MULTIPLE style, use GetPaths()
-        instead
+        For the controls having the @c wxFC_MULTIPLE style, use GetPaths() instead.

     */
     */

-    wxString GetPath();
+    wxString GetPath() const;

 
     /**
 
     /**

-        Fills the array @a paths with the full paths of the files chosen. This
-        function should be used with the controls having the @c wxFC_MULTIPLE style,
+        Fills the array @a paths with the full paths of the files chosen.
+
+        This function should be used with the controls having the @c wxFC_MULTIPLE style,

         use GetPath() otherwise.
         use GetPath() otherwise.

-        
+

         @remarks paths is emptied first.
     */
         @remarks paths is emptied first.
     */

-    void GetPaths(wxArrayString& paths);
+    void GetPaths(wxArrayString& paths) const;

 
     /**
         Returns the current wildcard.
     */
 
     /**
         Returns the current wildcard.
     */

-    wxString GetWildcard();
+    wxString GetWildcard() const;

 
     /**
         Sets(changes) the current directory displayed in the control.
 
     /**
         Sets(changes) the current directory displayed in the control.

-        
-        @returns Returns @true on success, @false otherwise.
+
+        @return Returns @true on success, @false otherwise.

     */
     bool SetDirectory(const wxString& directory);
 
     /**
         Selects a certain file.
     */
     bool SetDirectory(const wxString& directory);
 
     /**
         Selects a certain file.

-        
-        @returns Returns @true on success, @false otherwise
+
+        @return Returns @true on success, @false otherwise

     */
     bool SetFilename(const wxString& filename);
 
     */
     bool SetFilename(const wxString& filename);
 


@@ -170,6 +183,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxFileCtrlEvent
     @wxheader{filectrl.h}
 /**
     @class wxFileCtrlEvent
     @wxheader{filectrl.h}


@@ -177,8 +191,17 @@ public:
     A file control event holds information about events associated with
     wxFileCtrl objects.
 
     A file control event holds information about events associated with
     wxFileCtrl objects.
 

+    @beginEventTable{wxFileCtrlEvent}
+    @event{EVT_FILECTRL_FILEACTIVATED(id, func)}
+        The user activated a file(by double-clicking or pressing Enter)
+    @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)}
+        The user changed the current selection(by selecting or deselecting a file)
+    @event{EVT_FILECTRL_FOLDERCHANGED(id, func)}
+        The current folder of the file control has been changed
+    @endEventTable
+

     @library{wxbase}
     @library{wxbase}

-    @category{FIXME}
+    @category{events}

 */
 class wxFileCtrlEvent : public wxCommandEvent
 {
 */
 class wxFileCtrlEvent : public wxCommandEvent
 {


@@ -190,25 +213,34 @@ public:
 
     /**
         Returns the current directory.
 
     /**
         Returns the current directory.

+

         In case of a @b EVT_FILECTRL_FOLDERCHANGED, this method returns the new
         directory.
     */
         In case of a @b EVT_FILECTRL_FOLDERCHANGED, this method returns the new
         directory.
     */

-    wxString GetDirectory();
+    wxString GetDirectory() const;

 
     /**
 
     /**

-        Returns the file selected(assuming it is only one file).
+        Returns the file selected (assuming it is only one file).

     */
     */

-    wxString GetFile();
+    wxString GetFile() const;

 
     /**
         Returns the files selected.
 
     /**
         Returns the files selected.

+

         In case of a @b EVT_FILECTRL_SELECTIONCHANGED, this method returns the
         files selected after the event.
     */
         In case of a @b EVT_FILECTRL_SELECTIONCHANGED, this method returns the
         files selected after the event.
     */

-    wxArrayString GetFiles();
+    wxArrayString GetFiles() const;

 
     /**
         Sets the files changed by this event.
     */
 
     /**
         Sets the files changed by this event.
     */

-    wxFileCtrlEvent::SetFiles(const wxArrayString files);
+    void SetFiles(const wxArrayString files);
+
+
+    /**
+        Sets the directory of this event.
+    */
+    void SetDirectory( const wxString &directory );

 };
 };

+