Document that wxDC::FloodFill() is not implemented under wxOSX.

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

diff --git a/include/wx/artprov.h b/include/wx/artprov.h
index 2b1a62b774cd7e329dc50c51969a0341fbd4c8ef..7eef3973c4266c2fd1a0d479e6d086ea1ccbccfb 100644 (file)
--- a/include/wx/artprov.h
+++ b/include/wx/artprov.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        artprov.h
+// Name:        wx/artprov.h

 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:
 // Purpose:     wxArtProvider class
 // Author:      Vaclav Slavik
 // Modified by:


@@ -12,16 +12,14 @@
 #ifndef _WX_ARTPROV_H_
 #define _WX_ARTPROV_H_
 
 #ifndef _WX_ARTPROV_H_
 #define _WX_ARTPROV_H_
 

-#ifdef __GNUG__
-#pragma interface "artprov.h"
-#endif
-

 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/icon.h"
 #include "wx/string.h"
 #include "wx/bitmap.h"
 #include "wx/icon.h"

+#include "wx/iconbndl.h"

 
 

-class WXDLLEXPORT wxArtProvidersList;
-class WXDLLEXPORT wxArtProviderCache;
+class WXDLLIMPEXP_FWD_CORE wxArtProvidersList;
+class WXDLLIMPEXP_FWD_CORE wxArtProviderCache;
+class wxArtProviderModule;

 
 // ----------------------------------------------------------------------------
 // Types
 
 // ----------------------------------------------------------------------------
 // Types


@@ -30,75 +28,130 @@ class WXDLLEXPORT wxArtProviderCache;
 typedef wxString wxArtClient;
 typedef wxString wxArtID;
 
 typedef wxString wxArtClient;
 typedef wxString wxArtID;
 

+#define wxART_MAKE_CLIENT_ID_FROM_STR(id)  ((id) + "_C")
+#define wxART_MAKE_CLIENT_ID(id)           (#id "_C")
+#define wxART_MAKE_ART_ID_FROM_STR(id)     (id)
+#define wxART_MAKE_ART_ID(id)              (#id)
+

 // ----------------------------------------------------------------------------
 // Art clients
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // Art clients
 // ----------------------------------------------------------------------------
 

-#define wxART_TOOLBAR                  _T("toolbar_C")
-#define wxART_MENU                     _T("menu_C")
-#define wxART_FRAME_ICON               _T("frame_icon_C")
+#define wxART_TOOLBAR              wxART_MAKE_CLIENT_ID(wxART_TOOLBAR)
+#define wxART_MENU                 wxART_MAKE_CLIENT_ID(wxART_MENU)
+#define wxART_FRAME_ICON           wxART_MAKE_CLIENT_ID(wxART_FRAME_ICON)

 
 

-#define wxART_CMN_DIALOG               _T("cmn_dialog_C")
-#define wxART_HELP_BROWSER             _T("help_browser_C")
-#define wxART_MESSAGE_BOX              _T("message_box_C")
+#define wxART_CMN_DIALOG           wxART_MAKE_CLIENT_ID(wxART_CMN_DIALOG)
+#define wxART_HELP_BROWSER         wxART_MAKE_CLIENT_ID(wxART_HELP_BROWSER)
+#define wxART_MESSAGE_BOX          wxART_MAKE_CLIENT_ID(wxART_MESSAGE_BOX)
+#define wxART_BUTTON               wxART_MAKE_CLIENT_ID(wxART_BUTTON)
+#define wxART_LIST                 wxART_MAKE_CLIENT_ID(wxART_LIST)

 
 

-#define wxART_OTHER                    _T("other_C")
+#define wxART_OTHER                wxART_MAKE_CLIENT_ID(wxART_OTHER)

 
 // ----------------------------------------------------------------------------
 // Art IDs
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // Art IDs
 // ----------------------------------------------------------------------------
 

-#define wxART_ADD_BOOKMARK             _T("add_bookmark")
-#define wxART_DEL_BOOKMARK             _T("del_bookmark")
-#define wxART_HELP_SIDE_PANEL          _T("help_side_panel")
-#define wxART_HELP_SETTINGS            _T("help_settings")
-#define wxART_HELP_BOOK                _T("help_book")
-#define wxART_HELP_FOLDER              _T("help_folder")
-#define wxART_HELP_PAGE                _T("help_page")
-#define wxART_GO_BACK                  _T("go_back")
-#define wxART_GO_FORWARD               _T("go_forward")
-#define wxART_GO_UP                    _T("go_up")
-#define wxART_GO_DOWN                  _T("go_down")
-#define wxART_GO_TO_PARENT             _T("go_to_parent")
-#define wxART_GO_HOME                  _T("go_home")
-#define wxART_FILE_OPEN                _T("file_open")
-#define wxART_PRINT                    _T("print")
-#define wxART_HELP                     _T("help")
-#define wxART_TIP                      _T("tip")
-#define wxART_REPORT_VIEW              _T("report_view")
-#define wxART_LIST_VIEW                _T("list_view")
-#define wxART_NEW_DIR                  _T("new_dir")
-#define wxART_FOLDER                   _T("folder")
-#define wxART_GO_DIR_UP                _T("go_dir_up")
-#define wxART_EXECUTABLE_FILE          _T("executable_file")
-#define wxART_NORMAL_FILE              _T("normal_file")
-#define wxART_TICK_MARK                _T("tick")
-#define wxART_CROSS_MARK               _T("cross")
-#define wxART_ERROR                    _T("error")
-#define wxART_QUESTION                 _T("question")
-#define wxART_WARNING                  _T("warning")
-#define wxART_INFORMATION              _T("information")
+#define wxART_ADD_BOOKMARK         wxART_MAKE_ART_ID(wxART_ADD_BOOKMARK)
+#define wxART_DEL_BOOKMARK         wxART_MAKE_ART_ID(wxART_DEL_BOOKMARK)
+#define wxART_HELP_SIDE_PANEL      wxART_MAKE_ART_ID(wxART_HELP_SIDE_PANEL)
+#define wxART_HELP_SETTINGS        wxART_MAKE_ART_ID(wxART_HELP_SETTINGS)
+#define wxART_HELP_BOOK            wxART_MAKE_ART_ID(wxART_HELP_BOOK)
+#define wxART_HELP_FOLDER          wxART_MAKE_ART_ID(wxART_HELP_FOLDER)
+#define wxART_HELP_PAGE            wxART_MAKE_ART_ID(wxART_HELP_PAGE)
+#define wxART_GO_BACK              wxART_MAKE_ART_ID(wxART_GO_BACK)
+#define wxART_GO_FORWARD           wxART_MAKE_ART_ID(wxART_GO_FORWARD)
+#define wxART_GO_UP                wxART_MAKE_ART_ID(wxART_GO_UP)
+#define wxART_GO_DOWN              wxART_MAKE_ART_ID(wxART_GO_DOWN)
+#define wxART_GO_TO_PARENT         wxART_MAKE_ART_ID(wxART_GO_TO_PARENT)
+#define wxART_GO_HOME              wxART_MAKE_ART_ID(wxART_GO_HOME)
+#define wxART_GOTO_FIRST           wxART_MAKE_ART_ID(wxART_GOTO_FIRST)
+#define wxART_GOTO_LAST            wxART_MAKE_ART_ID(wxART_GOTO_LAST)
+#define wxART_FILE_OPEN            wxART_MAKE_ART_ID(wxART_FILE_OPEN)
+#define wxART_FILE_SAVE            wxART_MAKE_ART_ID(wxART_FILE_SAVE)
+#define wxART_FILE_SAVE_AS         wxART_MAKE_ART_ID(wxART_FILE_SAVE_AS)
+#define wxART_PRINT                wxART_MAKE_ART_ID(wxART_PRINT)
+#define wxART_HELP                 wxART_MAKE_ART_ID(wxART_HELP)
+#define wxART_TIP                  wxART_MAKE_ART_ID(wxART_TIP)
+#define wxART_REPORT_VIEW          wxART_MAKE_ART_ID(wxART_REPORT_VIEW)
+#define wxART_LIST_VIEW            wxART_MAKE_ART_ID(wxART_LIST_VIEW)
+#define wxART_NEW_DIR              wxART_MAKE_ART_ID(wxART_NEW_DIR)
+#define wxART_HARDDISK             wxART_MAKE_ART_ID(wxART_HARDDISK)
+#define wxART_FLOPPY               wxART_MAKE_ART_ID(wxART_FLOPPY)
+#define wxART_CDROM                wxART_MAKE_ART_ID(wxART_CDROM)
+#define wxART_REMOVABLE            wxART_MAKE_ART_ID(wxART_REMOVABLE)
+#define wxART_FOLDER               wxART_MAKE_ART_ID(wxART_FOLDER)
+#define wxART_FOLDER_OPEN          wxART_MAKE_ART_ID(wxART_FOLDER_OPEN)
+#define wxART_GO_DIR_UP            wxART_MAKE_ART_ID(wxART_GO_DIR_UP)
+#define wxART_EXECUTABLE_FILE      wxART_MAKE_ART_ID(wxART_EXECUTABLE_FILE)
+#define wxART_NORMAL_FILE          wxART_MAKE_ART_ID(wxART_NORMAL_FILE)
+#define wxART_TICK_MARK            wxART_MAKE_ART_ID(wxART_TICK_MARK)
+#define wxART_CROSS_MARK           wxART_MAKE_ART_ID(wxART_CROSS_MARK)
+#define wxART_ERROR                wxART_MAKE_ART_ID(wxART_ERROR)
+#define wxART_QUESTION             wxART_MAKE_ART_ID(wxART_QUESTION)
+#define wxART_WARNING              wxART_MAKE_ART_ID(wxART_WARNING)
+#define wxART_INFORMATION          wxART_MAKE_ART_ID(wxART_INFORMATION)
+#define wxART_MISSING_IMAGE        wxART_MAKE_ART_ID(wxART_MISSING_IMAGE)
+
+#define wxART_COPY                 wxART_MAKE_ART_ID(wxART_COPY)
+#define wxART_CUT                  wxART_MAKE_ART_ID(wxART_CUT)
+#define wxART_PASTE                wxART_MAKE_ART_ID(wxART_PASTE)
+#define wxART_DELETE               wxART_MAKE_ART_ID(wxART_DELETE)
+#define wxART_NEW                  wxART_MAKE_ART_ID(wxART_NEW)
+
+#define wxART_UNDO                 wxART_MAKE_ART_ID(wxART_UNDO)
+#define wxART_REDO                 wxART_MAKE_ART_ID(wxART_REDO)
+
+#define wxART_PLUS                 wxART_MAKE_ART_ID(wxART_PLUS)
+#define wxART_MINUS                wxART_MAKE_ART_ID(wxART_MINUS)
+
+#define wxART_CLOSE                wxART_MAKE_ART_ID(wxART_CLOSE)
+#define wxART_QUIT                 wxART_MAKE_ART_ID(wxART_QUIT)
+
+#define wxART_FIND                 wxART_MAKE_ART_ID(wxART_FIND)
+#define wxART_FIND_AND_REPLACE     wxART_MAKE_ART_ID(wxART_FIND_AND_REPLACE)
+

 
 // ----------------------------------------------------------------------------
 // wxArtProvider class
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxArtProvider class
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxArtProvider : public wxObject
+class WXDLLIMPEXP_CORE wxArtProvider : public wxObject

 {
 public:
 {
 public:

-    // Add new provider to the top of providers stack.
-    static void PushProvider(wxArtProvider *provider);
+    // Dtor removes the provider from providers stack if it's still on it
+    virtual ~wxArtProvider();
+
+    // Does this platform implement native icons theme?
+    static bool HasNativeProvider();
+
+    // Add new provider to the top of providers stack (i.e. the provider will
+    // be queried first of all).
+    static void Push(wxArtProvider *provider);
+
+    // Add new provider to the bottom of providers stack (i.e. the provider
+    // will be queried as the last one).
+    static void PushBack(wxArtProvider *provider);
+
+#if WXWIN_COMPATIBILITY_2_8
+    // use PushBack(), it's the same thing
+    static wxDEPRECATED( void Insert(wxArtProvider *provider) );
+#endif

 
     // Remove latest added provider and delete it.
 
     // Remove latest added provider and delete it.

-    static bool PopProvider();
+    static bool Pop();
+
+    // Remove provider from providers stack but don't delete it.
+    static bool Remove(wxArtProvider *provider);
+
+    // Delete the given provider and remove it from the providers stack.
+    static bool Delete(wxArtProvider *provider);
+

 
 

-    // Remove provider. The provider must have been added previously!
-    // The provider is _not_ deleted.
-    static bool RemoveProvider(wxArtProvider *provider);
-    

     // Query the providers for bitmap with given ID and return it. Return
     // wxNullBitmap if no provider provides it.
     // Query the providers for bitmap with given ID and return it. Return
     // wxNullBitmap if no provider provides it.

-    static wxBitmap GetBitmap(const wxArtID& id, 
+    static wxBitmap GetBitmap(const wxArtID& id,

                               const wxArtClient& client = wxART_OTHER,
                               const wxSize& size = wxDefaultSize);
 
                               const wxArtClient& client = wxART_OTHER,
                               const wxSize& size = wxDefaultSize);
 


@@ -108,21 +161,86 @@ public:
                           const wxArtClient& client = wxART_OTHER,
                           const wxSize& size = wxDefaultSize);
 
                           const wxArtClient& client = wxART_OTHER,
                           const wxSize& size = wxDefaultSize);
 

+    // Helper used by GetMessageBoxIcon(): return the art id corresponding to
+    // the standard wxICON_INFORMATION/WARNING/ERROR/QUESTION flags (only one
+    // can be set)
+    static wxArtID GetMessageBoxIconId(int flags);
+
+    // Helper used by several generic classes: return the icon corresponding to
+    // the standard wxICON_INFORMATION/WARNING/ERROR/QUESTION flags (only one
+    // can be set)
+    static wxIcon GetMessageBoxIcon(int flags)
+    {
+        return GetIcon(GetMessageBoxIconId(flags), wxART_MESSAGE_BOX);
+    }
+
+    // Query the providers for iconbundle with given ID and return it. Return
+    // wxNullIconBundle if no provider provides it.
+    static wxIconBundle GetIconBundle(const wxArtID& id,
+                                      const wxArtClient& client = wxART_OTHER);
+
+    // Gets native size for given 'client' or wxDefaultSize if it doesn't
+    // have native equivalent
+    static wxSize GetNativeSizeHint(const wxArtClient& client);
+
+    // Get the size hint of an icon from a specific wxArtClient, queries
+    // the topmost provider if platform_dependent = false
+    static wxSize GetSizeHint(const wxArtClient& client, bool platform_dependent = false);
+
+#if WXWIN_COMPATIBILITY_2_6
+    // use the corresponding methods without redundant "Provider" suffix
+    static wxDEPRECATED( void PushProvider(wxArtProvider *provider) );
+    static wxDEPRECATED( void InsertProvider(wxArtProvider *provider) );
+    static wxDEPRECATED( bool PopProvider() );
+
+    // use Delete() if this is what you really need, or just delete the
+    // provider pointer, do not use Remove() as it does not delete the pointer
+    // unlike RemoveProvider() which does
+    static wxDEPRECATED( bool RemoveProvider(wxArtProvider *provider) );
+#endif // WXWIN_COMPATIBILITY_2_6
+
+protected:
+    friend class wxArtProviderModule;
+#if wxUSE_ARTPROVIDER_STD
+    // Initializes default provider
+    static void InitStdProvider();
+#endif // wxUSE_ARTPROVIDER_STD
+    // Initializes Tango-based icon provider
+#if wxUSE_ARTPROVIDER_TANGO
+    static void InitTangoProvider();
+#endif // wxUSE_ARTPROVIDER_TANGO
+    // Initializes platform's native provider, if available (e.g. GTK2)
+    static void InitNativeProvider();

     // Destroy caches & all providers
     static void CleanUpProviders();
 
     // Destroy caches & all providers
     static void CleanUpProviders();
 

-protected:
-    // Derived classes must override this method to create requested 
-    // art resource. This method is called only once per instance's
-    // lifetime for each requested wxArtID.
+    // Get the default size of an icon for a specific client
+    virtual wxSize DoGetSizeHint(const wxArtClient& client)
+    {
+        return GetSizeHint(client, true);
+    }
+
+    // Derived classes must override CreateBitmap or CreateIconBundle
+    // (or both) to create requested art resource. This method is called
+    // only once per instance's lifetime for each requested wxArtID.

     virtual wxBitmap CreateBitmap(const wxArtID& WXUNUSED(id),
                                   const wxArtClient& WXUNUSED(client),
                                   const wxSize& WXUNUSED(size))
     {
     virtual wxBitmap CreateBitmap(const wxArtID& WXUNUSED(id),
                                   const wxArtClient& WXUNUSED(client),
                                   const wxSize& WXUNUSED(size))
     {

-        wxFAIL_MSG(_T("pure virtual method wxArtProvider::CreateBitmap called!"));

         return wxNullBitmap;
     }
 
         return wxNullBitmap;
     }
 

+    virtual wxIconBundle CreateIconBundle(const wxArtID& WXUNUSED(id),
+                                          const wxArtClient& WXUNUSED(client))
+    {
+        return wxNullIconBundle;
+    }
+
+private:
+    static void CommonAddingProvider();
+    static wxIconBundle DoGetIconBundle(const wxArtID& id,
+                                        const wxArtClient& client);
+

 private:
     // list of providers:
     static wxArtProvidersList *sm_providers;
 private:
     // list of providers:
     static wxArtProvidersList *sm_providers;


@@ -133,4 +251,12 @@ private:
 };
 
 
 };
 
 

+#if !defined(__WXUNIVERSAL__) && \
+    ((defined(__WXGTK__) && defined(__WXGTK20__)) || defined(__WXMSW__) || \
+     defined(__WXMAC__))
+  // *some* (partial) native implementation of wxArtProvider exists; this is
+  // not the same as wxArtProvider::HasNativeProvider()!
+  #define wxHAS_NATIVE_ART_PROVIDER_IMPL
+#endif
+

 #endif // _WX_ARTPROV_H_
 #endif // _WX_ARTPROV_H_