Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/filectrl.h b/include/wx/filectrl.h
index 0b7a40c9032332b6b204708469fa894f455d317f..d741ae2ab17a1a673c033b5d25ad4e49008f9bd3 100644 (file)
--- a/include/wx/filectrl.h
+++ b/include/wx/filectrl.h
@@ -25,17 +25,11 @@ enum
     wxFC_OPEN              = 0x0001,
     wxFC_SAVE              = 0x0002,
     wxFC_MULTIPLE          = 0x0004,
     wxFC_OPEN              = 0x0001,
     wxFC_SAVE              = 0x0002,
     wxFC_MULTIPLE          = 0x0004,

-    wxFC_NOSHOWHIDDEN      = 0x0008,
+    wxFC_NOSHOWHIDDEN      = 0x0008

 };
 
 #define wxFC_DEFAULT_STYLE wxFC_OPEN
 };
 
 #define wxFC_DEFAULT_STYLE wxFC_OPEN

-extern WXDLLEXPORT_DATA( const wxChar ) wxFileCtrlNameStr[];
-
-BEGIN_DECLARE_EVENT_TYPES()
-    DECLARE_EXPORTED_EVENT_TYPE( WXDLLIMPEXP_CORE, wxEVT_FILECTRL_SELECTIONCHANGED, 1150 )
-    DECLARE_EXPORTED_EVENT_TYPE( WXDLLIMPEXP_CORE, wxEVT_FILECTRL_FILEACTIVATED, 1151 )
-    DECLARE_EXPORTED_EVENT_TYPE( WXDLLIMPEXP_CORE, wxEVT_FILECTRL_FOLDERCHANGED, 1152 )
-END_DECLARE_EVENT_TYPES()
+extern WXDLLIMPEXP_DATA_CORE(const char) wxFileCtrlNameStr[]; // in filectrlcmn.cpp

 
 class WXDLLIMPEXP_CORE wxFileCtrlBase
 {
 
 class WXDLLIMPEXP_CORE wxFileCtrlBase
 {


@@ -69,11 +63,12 @@ public:
     virtual void ShowHidden(bool show) = 0;
 };
 
     virtual void ShowHidden(bool show) = 0;
 };
 

+void GenerateFilterChangedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd );

 void GenerateFolderChangedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd );
 void GenerateSelectionChangedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd );
 void GenerateFileActivatedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd, const wxString filename = wxEmptyString );
 
 void GenerateFolderChangedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd );
 void GenerateSelectionChangedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd );
 void GenerateFileActivatedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd, const wxString filename = wxEmptyString );
 

-#if defined(__WXGTK24__) && !defined(__WXUNIVERSAL__)
+#if defined(__WXGTK20__) && !defined(__WXUNIVERSAL__)

     #define wxFileCtrl wxGtkFileCtrl
     #include "wx/gtk/filectrl.h"
 #else
     #define wxFileCtrl wxGtkFileCtrl
     #include "wx/gtk/filectrl.h"
 #else


@@ -82,6 +77,8 @@ void GenerateFileActivatedEvent( wxFileCtrlBase *fileCtrl, wxWindow *wnd, const
 #endif
 
 // Some documentation
 #endif
 
 // Some documentation

+// On wxEVT_FILECTRL_FILTERCHANGED, only the value returned by GetFilterIndex is
+// valid and it represents the (new) current filter index for the wxFileCtrl.

 // On wxEVT_FILECTRL_FOLDERCHANGED, only the value returned by GetDirectory is
 // valid and it represents the (new) current directory for the wxFileCtrl.
 // On wxEVT_FILECTRL_FILEACTIVATED, GetDirectory returns the current directory
 // On wxEVT_FILECTRL_FOLDERCHANGED, only the value returned by GetDirectory is
 // valid and it represents the (new) current directory for the wxFileCtrl.
 // On wxEVT_FILECTRL_FILEACTIVATED, GetDirectory returns the current directory


@@ -106,13 +103,16 @@ public:
 
     void SetFiles( const wxArrayString &files ) { m_files = files; }
     void SetDirectory( const wxString &directory ) { m_directory = directory; }
 
     void SetFiles( const wxArrayString &files ) { m_files = files; }
     void SetDirectory( const wxString &directory ) { m_directory = directory; }

+    void SetFilterIndex( int filterIndex ) { m_filterIndex = filterIndex; }

 
     wxArrayString GetFiles() const { return m_files; }
     wxString GetDirectory() const { return m_directory; }
 
     wxArrayString GetFiles() const { return m_files; }
     wxString GetDirectory() const { return m_directory; }

+    int GetFilterIndex() const { return m_filterIndex; }

 
     wxString GetFile() const;
 
 protected:
 
     wxString GetFile() const;
 
 protected:

+    int m_filterIndex;

     wxString m_directory;
     wxArrayString m_files;
 
     wxString m_directory;
     wxArrayString m_files;
 


@@ -121,8 +121,13 @@ protected:
 
 typedef void ( wxEvtHandler::*wxFileCtrlEventFunction )( wxFileCtrlEvent& );
 
 
 typedef void ( wxEvtHandler::*wxFileCtrlEventFunction )( wxFileCtrlEvent& );
 

+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_FILECTRL_SELECTIONCHANGED, wxFileCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_FILECTRL_FILEACTIVATED, wxFileCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_FILECTRL_FOLDERCHANGED, wxFileCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_FILECTRL_FILTERCHANGED, wxFileCtrlEvent );
+

 #define wxFileCtrlEventHandler(func) \
 #define wxFileCtrlEventHandler(func) \

-    (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxFileCtrlEventFunction, &func)
+    wxEVENT_HANDLER_CAST( wxFileCtrlEventFunction, func )

 
 #define EVT_FILECTRL_FILEACTIVATED(id, fn) \
     wx__DECLARE_EVT1(wxEVT_FILECTRL_FILEACTIVATED, id, wxFileCtrlEventHandler(fn))
 
 #define EVT_FILECTRL_FILEACTIVATED(id, fn) \
     wx__DECLARE_EVT1(wxEVT_FILECTRL_FILEACTIVATED, id, wxFileCtrlEventHandler(fn))


@@ -133,6 +138,9 @@ typedef void ( wxEvtHandler::*wxFileCtrlEventFunction )( wxFileCtrlEvent& );
 #define EVT_FILECTRL_FOLDERCHANGED(id, fn) \
     wx__DECLARE_EVT1(wxEVT_FILECTRL_FOLDERCHANGED, id, wxFileCtrlEventHandler(fn))
 
 #define EVT_FILECTRL_FOLDERCHANGED(id, fn) \
     wx__DECLARE_EVT1(wxEVT_FILECTRL_FOLDERCHANGED, id, wxFileCtrlEventHandler(fn))
 

+#define EVT_FILECTRL_FILTERCHANGED(id, fn) \
+    wx__DECLARE_EVT1(wxEVT_FILECTRL_FILTERCHANGED, id, wxFileCtrlEventHandler(fn))
+

 #endif // wxUSE_FILECTRL
 
 #endif // _WX_FILECTRL_H_BASE_
 #endif // wxUSE_FILECTRL
 
 #endif // _WX_FILECTRL_H_BASE_