some wxArtProv docs

[wxWidgets.git] / src / common / artstd.cpp

diff --git a/src/common/artstd.cpp b/src/common/artstd.cpp
index bcd007fff3c67d08353151802305d5119b068bf9..cc08b0d756c8faa8410dc00cb7d58cf40b22b5ba 100644 (file)
--- a/src/common/artstd.cpp
+++ b/src/common/artstd.cpp
@@ -13,10 +13,6 @@
 // headers
 // ---------------------------------------------------------------------------
 
 // headers
 // ---------------------------------------------------------------------------
 

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

 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 


@@ -24,9 +20,18 @@
     #pragma hdrstop
 #endif
 
     #pragma hdrstop
 #endif
 

+#ifndef WX_PRECOMP
+    #if WXWIN_COMPATIBILITY_2_2
+        #include "wx/app.h"
+    #endif
+#endif
+

 #include "wx/artprov.h"
 #include "wx/module.h"
 
 #include "wx/artprov.h"
 #include "wx/module.h"
 

+// For the purposes of forcing this module to link
+char g_ArtProviderModule = 0;
+

 // ----------------------------------------------------------------------------
 // wxDefaultArtProvider
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxDefaultArtProvider
 // ----------------------------------------------------------------------------


@@ -34,13 +39,58 @@
 class wxDefaultArtProvider : public wxArtProvider
 {
 protected:
 class wxDefaultArtProvider : public wxArtProvider
 {
 protected:

-    virtual wxBitmap CreateBitmap(const wxArtDomain& domain, 
-                                  const wxArtID& id, const wxSize& size);
+    virtual wxBitmap CreateBitmap(const wxArtID& id, const wxArtClient& client,
+                                  const wxSize& size);

 };
 
 };
 

-#define BEGIN_DOMAIN(domainId) if ( domain == domainId ) {
-#define END_DOMAIN()           }
-#define ART_ID(artId, xpmRc)   if ( id == artId ) return wxBitmap(xpmRc##_xpm);
+// ----------------------------------------------------------------------------
+// helper macros
+// ----------------------------------------------------------------------------
+
+// Standard macro for getting a resource from XPM file:
+#define ART(artId, xpmRc) \
+    if ( id == artId ) return wxBitmap(xpmRc##_xpm);
+
+// Compatibility hack to use wxApp::GetStdIcon of overriden by the user
+#if WXWIN_COMPATIBILITY_2_2
+    #define GET_STD_ICON_FROM_APP(iconId) \
+        if ( client == wxART_MESSAGE_BOX ) \
+        { \
+            wxIcon icon = wxTheApp->GetStdIcon(iconId); \
+            if ( icon.Ok() ) \
+            { \
+                wxBitmap bmp; \
+                bmp.CopyFromIcon(icon); \
+                return bmp; \
+            } \
+        }
+#else
+    #define GET_STD_ICON_FROM_APP(iconId)
+#endif
+
+// There are two ways of getting the standard icon: either via XPMs or via
+// wxIcon ctor. This depends on the platform:
+#if defined(__WXUNIVERSAL__)
+    #define CREATE_STD_ICON(iconId, xpmRc) return wxNullBitmap;
+#elif defined(__WXGTK__) || defined(__WXMOTIF__)
+    #define CREATE_STD_ICON(iconId, xpmRc) return wxBitmap(xpmRc##_xpm);
+#else
+    #define CREATE_STD_ICON(iconId, xpmRc) \
+        { \
+            wxIcon icon(_T(iconId)); \
+            wxBitmap bmp; \
+            bmp.CopyFromIcon(icon); \
+            return bmp; \
+        }
+#endif
+
+// Macro used in CreateBitmap to get wxICON_FOO icons:
+#define ART_MSGBOX(artId, iconId, xpmRc) \
+    if ( id == artId ) \
+    { \
+        GET_STD_ICON_FROM_APP(iconId) \
+        CREATE_STD_ICON(#iconId, xpmRc) \
+    }

 
 // ----------------------------------------------------------------------------
 // wxDefaultArtProviderModule
 
 // ----------------------------------------------------------------------------
 // wxDefaultArtProviderModule


@@ -69,26 +119,47 @@ IMPLEMENT_DYNAMIC_CLASS(wxDefaultArtProviderModule, wxModule)
 // XPM hack: make the arrays const
 #define static static const
 
 // XPM hack: make the arrays const
 #define static static const
 

+#if defined(__WXGTK__)
+    #include "../../art/gtk/info.xpm"
+    #include "../../art/gtk/error.xpm"
+    #include "../../art/gtk/warning.xpm"
+    #include "../../art/gtk/question.xpm"
+#elif defined(__WXMOTIF__)
+    #include "../../art/motif/info.xpm"
+    #include "../../art/motif/error.xpm"
+    #include "../../art/motif/warning.xpm"
+    #include "../../art/motif/question.xpm"
+#endif
+

 #if wxUSE_HTML
 #if wxUSE_HTML

-#include "../../art/wxhtml/addbookm.xpm"
-#include "../../art/wxhtml/delbookm.xpm"
-#include "../../art/wxhtml/navig.xpm"
-#include "../../art/wxhtml/settings.xpm"
-#include "../../art/wxhtml/book.xpm"
-#include "../../art/wxhtml/folder.xpm"
-#include "../../art/wxhtml/page.xpm"
+    #include "../../art/htmsidep.xpm"
+    #include "../../art/htmoptns.xpm"
+    #include "../../art/htmbook.xpm"
+    #include "../../art/htmfoldr.xpm"
+    #include "../../art/htmpage.xpm"

 #endif // wxUSE_HTML
 
 #endif // wxUSE_HTML
 

-#include "../../art/browser/back.xpm"
-#include "../../art/browser/forward.xpm"
-#include "../../art/browser/up.xpm"
-#include "../../art/browser/down.xpm"
-#include "../../art/browser/toparent.xpm"
-
-#include "../../art/toolbar/fileopen.xpm"
-#include "../../art/toolbar/print.xpm"
-
-#include "../../art/framicon/help.xpm"
+#include "../../art/addbookm.xpm"
+#include "../../art/delbookm.xpm"
+#include "../../art/back.xpm"
+#include "../../art/forward.xpm"
+#include "../../art/up.xpm"
+#include "../../art/down.xpm"
+#include "../../art/toparent.xpm"
+#include "../../art/fileopen.xpm"
+#include "../../art/print.xpm"
+#include "../../art/helpicon.xpm"
+#include "../../art/tipicon.xpm"
+#include "../../art/home.xpm"
+#include "../../art/repview.xpm"
+#include "../../art/listview.xpm"
+#include "../../art/new_dir.xpm"
+#include "../../art/folder.xpm"
+#include "../../art/dir_up.xpm"
+#include "../../art/exefile.xpm"
+#include "../../art/deffile.xpm"
+#include "../../art/tick.xpm"
+#include "../../art/cross.xpm"

 
 #undef static
 
 
 #undef static
 


@@ -96,38 +167,45 @@ IMPLEMENT_DYNAMIC_CLASS(wxDefaultArtProviderModule, wxModule)
 // CreateBitmap routine
 // ----------------------------------------------------------------------------
 
 // CreateBitmap routine
 // ----------------------------------------------------------------------------
 

-wxBitmap wxDefaultArtProvider::CreateBitmap(const wxArtDomain& domain, 
-                                            const wxArtID& id,
+wxBitmap wxDefaultArtProvider::CreateBitmap(const wxArtID& id,
+                                            const wxArtClient& client,

                                             const wxSize& size)
 {
                                             const wxSize& size)
 {

+    // wxMessageBox icons:
+    ART_MSGBOX(wxART_ERROR,       wxICON_ERROR,       error)
+    ART_MSGBOX(wxART_INFORMATION, wxICON_INFORMATION, info)
+    ART_MSGBOX(wxART_WARNING,     wxICON_WARNING,     warning)
+    ART_MSGBOX(wxART_QUESTION,    wxICON_QUESTION,    question)
+
+    // standard icons:

 #if wxUSE_HTML
 #if wxUSE_HTML

-    BEGIN_DOMAIN(wxART_WXHTML)
-        ART_ID(wxART_ADD_BOOKMARK,     addbookm)
-        ART_ID(wxART_DEL_BOOKMARK,     delbookm)
-        ART_ID(wxART_NAVIG_PANEL,      navig)
-        ART_ID(wxART_HELP_SETTINGS,    settings)
-        ART_ID(wxART_HELP_BOOK,        book)
-        ART_ID(wxART_HELP_FOLDER,      folder)
-        ART_ID(wxART_HELP_PAGE,        page)
-    END_DOMAIN()
+    ART(wxART_HELP_SIDE_PANEL,                     htmsidep)
+    ART(wxART_HELP_SETTINGS,                       htmoptns)
+    ART(wxART_HELP_BOOK,                           htmbook)
+    ART(wxART_HELP_FOLDER,                         htmfoldr)
+    ART(wxART_HELP_PAGE,                           htmpage)

 #endif // wxUSE_HTML
 #endif // wxUSE_HTML

-
-    BEGIN_DOMAIN(wxART_BROWSER_TOOLBAR)
-        ART_ID(wxART_GO_BACK,          back)
-        ART_ID(wxART_GO_FORWARD,       forward)
-        ART_ID(wxART_GO_UP,            up)
-        ART_ID(wxART_GO_DOWN,          down)
-        ART_ID(wxART_GO_TO_PARENT,     toparent)
-    END_DOMAIN()
-
-    BEGIN_DOMAIN(wxART_TOOLBAR)
-        ART_ID(wxART_FILE_OPEN,        fileopen)
-        ART_ID(wxART_PRINT,            print)
-    END_DOMAIN()
-
-    BEGIN_DOMAIN(wxART_FRAME_ICON)
-        ART_ID(wxART_HELP,             help)
-    END_DOMAIN()
+    ART(wxART_ADD_BOOKMARK,                        addbookm)
+    ART(wxART_DEL_BOOKMARK,                        delbookm)
+    ART(wxART_GO_BACK,                             back)
+    ART(wxART_GO_FORWARD,                          forward)
+    ART(wxART_GO_UP,                               up)
+    ART(wxART_GO_DOWN,                             down)
+    ART(wxART_GO_TO_PARENT,                        toparent)
+    ART(wxART_GO_HOME,                             home)
+    ART(wxART_FILE_OPEN,                           fileopen)
+    ART(wxART_PRINT,                               print)
+    ART(wxART_HELP,                                helpicon)
+    ART(wxART_TIP,                                 tipicon)
+    ART(wxART_REPORT_VIEW,                         repview)
+    ART(wxART_LIST_VIEW,                           listview)
+    ART(wxART_NEW_DIR,                             new_dir)
+    ART(wxART_FOLDER,                              folder)
+    ART(wxART_GO_DIR_UP,                           dir_up)
+    ART(wxART_EXECUTABLE_FILE,                     exefile)
+    ART(wxART_NORMAL_FILE,                         deffile)
+    ART(wxART_TICK_MARK,                           tick)
+    ART(wxART_CROSS_MARK,                          cross)

 
     return wxNullBitmap;
 }
 
     return wxNullBitmap;
 }