wxPython/src/_artprov.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _artprov.i
   3 // Purpose:     SWIG interface stuff for wxArtProvider
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     18-June-1999
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup
  18
  19 %{
  20 #include <wx/artprov.h>
  21 %}
  22
  23 //---------------------------------------------------------------------------
  24
  25
  26 // Art clients
  27 MAKE_CONST_WXSTRING(ART_TOOLBAR);
  28 MAKE_CONST_WXSTRING(ART_MENU);
  29 MAKE_CONST_WXSTRING(ART_FRAME_ICON);
  30 MAKE_CONST_WXSTRING(ART_CMN_DIALOG);
  31 MAKE_CONST_WXSTRING(ART_HELP_BROWSER);
  32 MAKE_CONST_WXSTRING(ART_MESSAGE_BOX);
  33 MAKE_CONST_WXSTRING(ART_BUTTON);
  34 MAKE_CONST_WXSTRING(ART_OTHER);
  35
  36 // Art IDs
  37 MAKE_CONST_WXSTRING(ART_ADD_BOOKMARK);
  38 MAKE_CONST_WXSTRING(ART_DEL_BOOKMARK);
  39 MAKE_CONST_WXSTRING(ART_HELP_SIDE_PANEL);
  40 MAKE_CONST_WXSTRING(ART_HELP_SETTINGS);
  41 MAKE_CONST_WXSTRING(ART_HELP_BOOK);
  42 MAKE_CONST_WXSTRING(ART_HELP_FOLDER);
  43 MAKE_CONST_WXSTRING(ART_HELP_PAGE);
  44 MAKE_CONST_WXSTRING(ART_GO_BACK);
  45 MAKE_CONST_WXSTRING(ART_GO_FORWARD);
  46 MAKE_CONST_WXSTRING(ART_GO_UP);
  47 MAKE_CONST_WXSTRING(ART_GO_DOWN);
  48 MAKE_CONST_WXSTRING(ART_GO_TO_PARENT);
  49 MAKE_CONST_WXSTRING(ART_GO_HOME);
  50 MAKE_CONST_WXSTRING(ART_FILE_OPEN);
  51 MAKE_CONST_WXSTRING(ART_PRINT);
  52 MAKE_CONST_WXSTRING(ART_HELP);
  53 MAKE_CONST_WXSTRING(ART_TIP);
  54 MAKE_CONST_WXSTRING(ART_REPORT_VIEW);
  55 MAKE_CONST_WXSTRING(ART_LIST_VIEW);
  56 MAKE_CONST_WXSTRING(ART_NEW_DIR);
  57 MAKE_CONST_WXSTRING(ART_HARDDISK);
  58 MAKE_CONST_WXSTRING(ART_FLOPPY);
  59 MAKE_CONST_WXSTRING(ART_CDROM);
  60 MAKE_CONST_WXSTRING(ART_REMOVABLE);
  61 MAKE_CONST_WXSTRING(ART_FOLDER);
  62 MAKE_CONST_WXSTRING(ART_FOLDER_OPEN);
  63 MAKE_CONST_WXSTRING(ART_GO_DIR_UP);
  64 MAKE_CONST_WXSTRING(ART_EXECUTABLE_FILE);
  65 MAKE_CONST_WXSTRING(ART_NORMAL_FILE);
  66 MAKE_CONST_WXSTRING(ART_TICK_MARK);
  67 MAKE_CONST_WXSTRING(ART_CROSS_MARK);
  68 MAKE_CONST_WXSTRING(ART_ERROR);
  69 MAKE_CONST_WXSTRING(ART_QUESTION);
  70 MAKE_CONST_WXSTRING(ART_WARNING);
  71 MAKE_CONST_WXSTRING(ART_INFORMATION);
  72 MAKE_CONST_WXSTRING(ART_MISSING_IMAGE);
  73
  74 //---------------------------------------------------------------------------
  75
  76 %{  // Python aware wxArtProvider
  77 class wxPyArtProvider : public wxArtProvider  {
  78 public:
  79
  80     virtual wxBitmap CreateBitmap(const wxArtID& id,
  81                                   const wxArtClient& client,
  82                                   const wxSize& size) {
  83         wxBitmap rval = wxNullBitmap;
  84         bool blocked = wxPyBeginBlockThreads();
  85         if ((wxPyCBH_findCallback(m_myInst, "CreateBitmap"))) {
  86             PyObject* so = wxPyConstructObject((void*)&size, wxT("wxSize"), 0);
  87             PyObject* ro;
  88             wxBitmap* ptr;
  89             PyObject* s1, *s2;
  90             s1 = wx2PyString(id);
  91             s2 = wx2PyString(client);
  92             ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(OOO)", s1, s2, so));
  93             Py_DECREF(so);
  94             Py_DECREF(s1);
  95             Py_DECREF(s2);
  96             if (ro) {
  97                 if (wxPyConvertSwigPtr(ro, (void**)&ptr, wxT("wxBitmap")))
  98                     rval = *ptr;
  99                 Py_DECREF(ro);
 100             }
 101         }
 102         wxPyEndBlockThreads(blocked);
 103         return rval;
 104     }
 105
 106     PYPRIVATE;
 107 };
 108 %}
 109
 110 // The one for SWIG to see
 111
 112
 113
 114 DocStr(wxPyArtProvider,
 115 "The wx.ArtProvider class is used to customize the look of wxWidgets
 116 application. When wxWidgets needs to display an icon or a bitmap (e.g.
 117 in the standard file dialog), it does not use hard-coded resource but
 118 asks wx.ArtProvider for it instead. This way the users can plug in
 119 their own wx.ArtProvider class and easily replace standard art with
 120 his/her own version. It is easy thing to do: all that is needed is
 121 to derive a class from wx.ArtProvider, override it's CreateBitmap
 122 method and register the provider with wx.ArtProvider.PushProvider::
 123
 124     class MyArtProvider(wx.ArtProvider):
 125         def __init__(self):
 126             wx.ArtProvider.__init__(self)
 127
 128         def CreateBitmap(self, artid, client, size):
 129             ...
 130             return bmp
 131 ", "
 132
 133 Identifying art resources
 134 -------------------------
 135
 136 Every bitmap is known to wx.ArtProvider under an unique ID that is
 137 used when requesting a resource from it. The IDs can have one of the
 138 following predefined values.  Additionally, any string recognized by
 139 custom art providers registered using `PushProvider` may be used.
 140
 141 GTK+ Note
 142 ---------
 143
 144 When running under GTK+ 2, GTK+ stock item IDs (e.g. 'gtk-cdrom') may be used
 145 as well.  Additionally, if wxGTK was compiled against GTK+ >= 2.4, then it is
 146 also possible to load icons from current icon theme by specifying their name
 147 without the extension and directory components. Icon themes recognized by GTK+
 148 follow the freedesktop.org Icon Themes specification.  Note that themes are
 149 not guaranteed to contain all icons, so wx.ArtProvider may return wx.NullBitmap
 150 or wx.NullIcon.  The default theme is typically installed in /usr/share/icons/hicolor.
 151
 152
 153     * wx.ART_ADD_BOOKMARK
 154     * wx.ART_DEL_BOOKMARK
 155     * wx.ART_HELP_SIDE_PANEL
 156     * wx.ART_HELP_SETTINGS
 157     * wx.ART_HELP_BOOK
 158     * wx.ART_HELP_FOLDER
 159     * wx.ART_HELP_PAGE
 160     * wx.ART_GO_BACK
 161     * wx.ART_GO_FORWARD
 162     * wx.ART_GO_UP
 163     * wx.ART_GO_DOWN
 164     * wx.ART_GO_TO_PARENT
 165     * wx.ART_GO_HOME
 166     * wx.ART_FILE_OPEN
 167     * wx.ART_PRINT
 168     * wx.ART_HELP
 169     * wx.ART_TIP
 170     * wx.ART_REPORT_VIEW
 171     * wx.ART_LIST_VIEW
 172     * wx.ART_NEW_DIR
 173     * wx.ART_FOLDER
 174     * wx.ART_GO_DIR_UP
 175     * wx.ART_EXECUTABLE_FILE
 176     * wx.ART_NORMAL_FILE
 177     * wx.ART_TICK_MARK
 178     * wx.ART_CROSS_MARK
 179     * wx.ART_ERROR
 180     * wx.ART_QUESTION
 181     * wx.ART_WARNING
 182     * wx.ART_INFORMATION
 183     * wx.ART_MISSING_IMAGE
 184
 185
 186 Clients
 187 -------
 188
 189 The Client is the entity that calls wx.ArtProvider's `GetBitmap` or
 190 `GetIcon` function.  Client IDs serve as a hint to wx.ArtProvider
 191 that is supposed to help it to choose the best looking bitmap. For
 192 example it is often desirable to use slightly different icons in menus
 193 and toolbars even though they represent the same action (e.g.
 194 wx.ART_FILE_OPEN). Remember that this is really only a hint for
 195 wx.ArtProvider -- it is common that `wx.ArtProvider.GetBitmap` returns
 196 identical bitmap for different client values!
 197
 198     * wx.ART_TOOLBAR
 199     * wx.ART_MENU
 200     * wx.ART_FRAME_ICON
 201     * wx.ART_CMN_DIALOG
 202     * wx.ART_HELP_BROWSER
 203     * wx.ART_MESSAGE_BOX
 204     * wx.ART_BUTTON
 205     * wx.ART_OTHER (used for all requests that don't fit into any
 206       of the categories above)
 207 ");
 208
 209 MustHaveApp(wxPyArtProvider);
 210 MustHaveApp(wxPyArtProvider::GetBitmap);
 211 MustHaveApp(wxPyArtProvider::GetIcon);
 212
 213 %name(ArtProvider) class wxPyArtProvider /*: public wxObject*/
 214 {
 215 public:
 216
 217     %pythonAppend wxPyArtProvider "self._setCallbackInfo(self, ArtProvider)"
 218     wxPyArtProvider();
 219
 220     void _setCallbackInfo(PyObject* self, PyObject* _class);
 221
 222     DocDeclStr(
 223         static void , PushProvider(wxPyArtProvider *provider),
 224         "Add new provider to the top of providers stack.", "");
 225
 226
 227     DocDeclStr(
 228         static bool , PopProvider(),
 229         "Remove latest added provider and delete it.", "");
 230
 231
 232     DocDeclStr(
 233         static bool , RemoveProvider(wxPyArtProvider *provider),
 234         "Remove provider. The provider must have been added previously!  The
 235 provider is _not_ deleted.", "");
 236
 237
 238     DocDeclStr(
 239         static wxBitmap , GetBitmap(const wxString& id,
 240                                     const wxString& client = wxPyART_OTHER,
 241                                     const wxSize& size = wxDefaultSize),
 242         "Query the providers for bitmap with given ID and return it. Return
 243 wx.NullBitmap if no provider provides it.", "");
 244
 245
 246     DocDeclStr(
 247         static wxIcon , GetIcon(const wxString& id,
 248                           const wxString& client = wxPyART_OTHER,
 249                                 const wxSize& size = wxDefaultSize),
 250         "Query the providers for icon with given ID and return it.  Return
 251 wx.NullIcon if no provider provides it.", "");
 252
 253
 254     %extend { void Destroy() { delete self; }}
 255 };
 256
 257
 258
 259 //---------------------------------------------------------------------------
 260 %init %{
 261     wxPyPtrTypeMap_Add("wxArtProvider", "wxPyArtProvider");
 262 %}
 263 //---------------------------------------------------------------------------