wxPython/src/_bitmap.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _bitmap.i
   3 // Purpose:     SWIG interface for wxBitmap and wxMask
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     7-July-1997
   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
  18 %{
  19 #include <wx/image.h>
  20
  21     static char** ConvertListOfStrings(PyObject* listOfStrings) {
  22         char**    cArray = NULL;
  23         int       count;
  24
  25         if (!PyList_Check(listOfStrings)) {
  26             PyErr_SetString(PyExc_TypeError, "Expected a list of strings.");
  27             return NULL;
  28         }
  29         count = PyList_Size(listOfStrings);
  30         cArray = new char*[count];
  31
  32         for(int x=0; x<count; x++) {
  33             // TODO: Need some validation and error checking here
  34             cArray[x] = PyString_AsString(PyList_GET_ITEM(listOfStrings, x));
  35         }
  36         return cArray;
  37     }
  38
  39 %}
  40
  41 //---------------------------------------------------------------------------
  42
  43 // TODO:  When the API stabalizes and is available on other platforms, add
  44 // wrappers for the new wxBitmap, wxRawBitmap, wxDIB stuff...
  45
  46
  47 class wxBitmap : public wxGDIObject
  48 {
  49 public:
  50     DocCtorStr(
  51         wxBitmap(const wxString& name, wxBitmapType type=wxBITMAP_TYPE_ANY),
  52         "Loads a bitmap from a file.");
  53
  54     ~wxBitmap();
  55
  56     DocCtorStrName(
  57         wxBitmap(int width, int height, int depth=-1),
  58         "Creates a new bitmap of the given size.  A depth of -1 indicates the depth of\n"
  59         "the current screen or visual. Some platforms only support 1 for monochrome and\n"
  60         "-1 for the current colour setting.",
  61         EmptyBitmap);
  62
  63     DocCtorStrName(
  64         wxBitmap(const wxIcon& icon),
  65         "Create a new bitmap from an Icon object.",
  66         BitmapFromIcon);
  67
  68     DocCtorStrName(
  69         wxBitmap(const wxImage& image, int depth=-1),
  70         "Creates bitmap object from the image. This has to be done to actually display\n"
  71         "an image as you cannot draw an image directly on a window. The resulting\n"
  72         "bitmap will use the provided colour depth (or that of the current system if\n"
  73         "depth is -1) which entails that a colour reduction has to take place.",
  74         BitmapFromImage);
  75
  76
  77     %extend {
  78         DocStr(wxBitmap(PyObject* listOfStrings),
  79                "Construct a Bitmap from a list of strings formatted as XPM data.");
  80         %name(BitmapFromXPMData) wxBitmap(PyObject* listOfStrings) {
  81             char**    cArray = NULL;
  82             wxBitmap* bmp;
  83
  84             cArray = ConvertListOfStrings(listOfStrings);
  85             if (! cArray)
  86                 return NULL;
  87             bmp = new wxBitmap(cArray);
  88             delete [] cArray;
  89             return bmp;
  90         }
  91
  92         DocStr(wxBitmap(PyObject* bits, int width, int height, int depth=1 ),
  93                "Creates a bitmap from an array of bits.  You should only use this function for\n"
  94                "monochrome bitmaps (depth 1) in portable programs: in this case the bits\n"
  95                "parameter should contain an XBM image.  For other bit depths, the behaviour is\n"
  96                "platform dependent.");
  97         %name(BitmapFromBits) wxBitmap(PyObject* bits, int width, int height, int depth=1 ) {
  98             char* buf;
  99             int   length;
 100             PyString_AsStringAndSize(bits, &buf, &length);
 101             return new wxBitmap(buf, width, height, depth);
 102         }
 103     }
 104
 105
 106 #ifdef __WXMSW__
 107     void SetPalette(wxPalette& palette);
 108 #endif
 109
 110     // wxGDIImage methods
 111 #ifdef __WXMSW__
 112     long GetHandle();
 113     %extend {
 114         void SetHandle(long handle) { self->SetHandle((WXHANDLE)handle); }
 115     }
 116 #endif
 117
 118     bool Ok();
 119
 120     DocStr(GetWidth, "Gets the width of the bitmap in pixels.");
 121     int GetWidth();
 122
 123     DocStr(GetHeight, "Gets the height of the bitmap in pixels.");
 124     int GetHeight();
 125
 126     DocStr(GetDepth,
 127            "Gets the colour depth of the bitmap. A value of 1 indicates a\n"
 128            "monochrome bitmap.");
 129     int GetDepth();
 130
 131     DocStr(ConvertToImage,
 132            "Creates a platform-independent image from a platform-dependent bitmap. This\n"
 133            "preserves mask information so that bitmaps and images can be converted back\n"
 134            "and forth without loss in that respect.");
 135     virtual wxImage ConvertToImage() const;
 136
 137     DocStr(GetMask,
 138            "Gets the associated mask (if any) which may have been loaded from a file\n"
 139            "or explpicitly set for the bitmap.");
 140     virtual wxMask* GetMask() const;
 141
 142     DocStr(SetMask,
 143            "Sets the mask for this bitmap.");
 144     virtual void SetMask(wxMask* mask);
 145
 146     %extend {
 147         DocStr(SetMaskColour,
 148                "Create a Mask based on a specified colour in the Bitmap.");
 149         void SetMaskColour(const wxColour& colour) {
 150             wxMask *mask = new wxMask(*self, colour);
 151             self->SetMask(mask);
 152         }
 153     }
 154
 155     DocStr(GetSubBitmap,
 156            "Returns a sub bitmap of the current one as long as the rect belongs entirely\n"
 157            "to the bitmap. This function preserves bit depth and mask information.");
 158     virtual wxBitmap GetSubBitmap(const wxRect& rect) const;
 159
 160     DocStr(SaveFile, "Saves a bitmap in the named file.");
 161     virtual bool SaveFile(const wxString &name, wxBitmapType type,
 162                           wxPalette *palette = (wxPalette *)NULL);
 163
 164     DocStr(LoadFile, "Loads a bitmap from a file");
 165     virtual bool LoadFile(const wxString &name, wxBitmapType type);
 166
 167
 168 #if wxUSE_PALETTE
 169     virtual wxPalette *GetPalette() const;
 170     virtual void SetPalette(const wxPalette& palette);
 171 #endif
 172
 173
 174     virtual bool CopyFromIcon(const wxIcon& icon);
 175
 176     DocStr(SetHeight, "Set the height property (does not affect the bitmap data).")
 177     virtual void SetHeight(int height);
 178
 179     DocStr(SetWidth, "Set the width property (does not affect the bitmap data).")
 180     virtual void SetWidth(int width);
 181
 182     DocStr(SetDepth, "Set the depth property (does not affect the bitmap data).")
 183     virtual void SetDepth(int depth);
 184
 185
 186 #ifdef __WXMSW__
 187     bool CopyFromCursor(const wxCursor& cursor);
 188     int GetQuality();
 189     void SetQuality(int q);
 190 #endif
 191
 192     %pythoncode { def __nonzero__(self): return self.Ok() }
 193
 194     %extend {
 195         bool __eq__(const wxBitmap* other) { return other ? (*self == *other) : False; }
 196         bool __ne__(const wxBitmap* other) { return other ? (*self != *other) : True;  }
 197     }
 198 };
 199
 200
 201 //---------------------------------------------------------------------------
 202
 203 DocStr(wxMask,
 204        "This class encapsulates a monochrome mask bitmap, where the masked area is\n"
 205        "black and the unmasked area is white. When associated with a bitmap and drawn\n"
 206        "in a device context, the unmasked area of the bitmap will be drawn, and the\n"
 207        "masked area will not be drawn.");
 208
 209 class wxMask : public wxObject {
 210 public:
 211 #if 0
 212     DocCtorStr(
 213         wxMask(const wxBitmap& bitmap),
 214         "Constructs a mask from a monochrome bitmap.");
 215 #endif
 216
 217     DocStr(wxMask,
 218            "Constructs a mask from a bitmap and a colour in that bitmap that indicates\n"
 219            "the transparent portions of the mask, by default BLACK is used.");
 220
 221     %extend {
 222         wxMask(const wxBitmap& bitmap, const wxColour& colour = wxNullColour) {
 223             if ( !colour.Ok() )
 224                 return new wxMask(bitmap, *wxBLACK);
 225             else
 226                 return new wxMask(bitmap, colour);
 227         }
 228     }
 229
 230     //~wxMask();
 231 };
 232
 233 %pythoncode { MaskColour = Mask }
 234
 235 //---------------------------------------------------------------------------
 236 //---------------------------------------------------------------------------