Correct names of parameters in wxAffineMatrix2D documentation.

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

diff --git a/interface/wx/filectrl.h b/interface/wx/filectrl.h
index 72149989d554a93133fc3a9cdbb94b630a55ba21..4681df1149e345474d9239d51c82da05c1205e65 100644 (file)
--- a/interface/wx/filectrl.h
+++ b/interface/wx/filectrl.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxFileCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxFileCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -11,8 +11,10 @@
 
     This control allows the user to select a file.
 
 
     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.
+    Two implementations of this class exist, one for Gtk and another generic
+    one for all the other ports.
+
+    This class is only available if @c wxUSE_FILECTRL is set to 1.

 
     @beginStyleTable
     @style{wxFC_DEFAULT_STYLE}
 
     @beginStyleTable
     @style{wxFC_DEFAULT_STYLE}


@@ -30,24 +32,28 @@
            Hides the "Show Hidden Files" checkbox (Generic only)
     @endStyleTable
 
            Hides the "Show Hidden Files" checkbox (Generic only)
     @endStyleTable
 

-
-    @beginEventTable{wxFileCtrlEvent}
+    @beginEventEmissionTable{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
     @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
+    @event{EVT_FILECTRL_FILTERCHANGED(id, func)}
+        The current file filter of the file control has been changed.
+        @since 2.9.1.

 
 

-    @nativeimpl{wxgtk}
+    @endEventTable

 
     @library{wxbase}
 
     @library{wxbase}

-    @category{miscwnd}
+    @category{ctrl}
+    @appearance{filectrl.png}
+
+    @nativeimpl{wxgtk}

 
     @see wxGenericDirCtrl
 */
 
     @see wxGenericDirCtrl
 */

-class wxFileCtrl : public wxWindow
+class wxFileCtrl : public wxControl

 {
 public:
     wxFileCtrl();
 {
 public:
     wxFileCtrl();


@@ -88,7 +94,7 @@ public:
                long style = wxFC_DEFAULT_STYLE,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = wxFC_DEFAULT_STYLE,
                const wxPoint& pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,

-               const wxString& name = "filectrl");
+               const wxString& name = wxFileCtrlNameStr);

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


@@ -195,6 +201,8 @@ public:
         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
         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

+    @event{EVT_FILECTRL_FILTERCHANGED(id, func)}
+        The current file filter of the file control has been changed

     @endEventTable
 
     @library{wxbase}
     @endEventTable
 
     @library{wxbase}


@@ -206,7 +214,7 @@ public:
     /**
         Constructor.
     */
     /**
         Constructor.
     */

-    wxFileCtrlEvent(wxEventType type, wxObject evtObject, int id);
+    wxFileCtrlEvent(wxEventType type, wxObject *evtObject, int id);

 
     /**
         Returns the current directory.
 
     /**
         Returns the current directory.


@@ -229,6 +237,16 @@ public:
     */
     wxArrayString GetFiles() const;
 
     */
     wxArrayString GetFiles() const;
 

+    /**
+        Returns the current file filter index.
+
+        For a @b EVT_FILECTRL_FILTERCHANGED event, this method returns the new
+        file filter index.
+
+        @since 2.9.1
+    */
+    int GetFilterIndex() const;
+

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


@@ -239,5 +257,12 @@ public:
         Sets the directory of this event.
     */
     void SetDirectory( const wxString &directory );
         Sets the directory of this event.
     */
     void SetDirectory( const wxString &directory );

+
+    /**
+        Sets the filter index changed by this event.
+
+        @since 2.9.1
+    */
+    void SetFilterIndex(int index);

 };
 
 };