///////////////////////////////////////////////////////////////////////////// // Name: gdi.i // Purpose: SWIG interface file for wxDC, wxBrush, wxPen, wxFont, etc. // // Author: Robin Dunn // // Created: 7/7/97 // RCS-ID: $Id$ // Copyright: (c) 1998 by Total Control Software // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// %module gdi %{ #include "helpers.h" #include #include #include #include #include %} //---------------------------------------------------------------------- %include typemaps.i %include my_typemaps.i // Import some definitions of other classes, etc. %import _defs.i %import misc.i %{ static wxString wxPyEmptyStr(""); %} //--------------------------------------------------------------------------- class wxGDIObject : public wxObject { public: wxGDIObject(); ~wxGDIObject(); bool GetVisible(); void SetVisible( bool visible ); bool IsNull(); }; //--------------------------------------------------------------------------- class wxBitmap : public wxGDIObject { public: wxBitmap(const wxString& name, wxBitmapType type=wxBITMAP_TYPE_BMP); ~wxBitmap(); wxPalette* GetPalette(); wxMask* GetMask(); bool LoadFile(const wxString& name, wxBitmapType type=wxBITMAP_TYPE_BMP); bool SaveFile(const wxString& name, wxBitmapType type, wxPalette* palette = NULL); void SetMask(wxMask* mask); #ifdef __WXMSW__ void SetPalette(wxPalette& palette); #endif // wxGDIImage methods #ifdef __WXMSW__ long GetHandle(); void SetHandle(long handle); #endif bool Ok(); int GetWidth(); int GetHeight(); int GetDepth(); void SetWidth(int w); void SetHeight(int h); void SetDepth(int d); #ifdef __WXMSW__ void SetSize(const wxSize& size); #endif wxBitmap GetSubBitmap( const wxRect& rect ); bool CopyFromIcon(const wxIcon& icon); #ifdef __WXMSW__ bool CopyFromCursor(const wxCursor& cursor); int GetQuality(); void SetQuality(int q); #endif %pragma(python) addtoclass = " def __del__(self,gdic=gdic): try: if self.thisown == 1 : gdic.delete_wxBitmap(self) except: pass " }; // Declarations of some alternate "constructors" %new wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1); %new wxBitmap* wxBitmapFromXPMData(PyObject* listOfStrings); %new wxBitmap* wxBitmapFromIcon(const wxIcon& icon); %new wxBitmap* wxBitmapFromBits(char* bits, int width, int height, int depth = 1 ); // #ifdef __WXMSW__ // %new wxBitmap* wxBitmapFromData(PyObject* data, long type, // int width, int height, int depth = 1); // #endif %{ // Implementations of some alternate "constructors" wxBitmap* wxEmptyBitmap(int width, int height, int depth=-1) { return new wxBitmap(width, height, depth); } static char** ConvertListOfStrings(PyObject* listOfStrings) { char** cArray = NULL; int count; if (!PyList_Check(listOfStrings)) { PyErr_SetString(PyExc_TypeError, "Expected a list of strings."); return NULL; } count = PyList_Size(listOfStrings); cArray = new char*[count]; for(int x=0; xToString(); } } }; // wxFontMapper manages user-definable correspondence between logical font // names and the fonts present on the machine. // // The default implementations of all functions will ask the user if they are // not capable of finding the answer themselves and store the answer in a // config file (configurable via SetConfigXXX functions). This behaviour may // be disabled by giving the value of FALSE to "interactive" parameter. // However, the functions will always consult the config file to allow the // user-defined values override the default logic and there is no way to // disable this - which shouldn't be ever needed because if "interactive" was // never TRUE, the config file is never created anyhow. class wxFontMapper { public: wxFontMapper(); ~wxFontMapper(); // find an alternative for the given encoding (which is supposed to not be // available on this system). If successful, return TRUE and rwxFontEcoding // that can be used it wxFont ctor otherwise return FALSE //bool GetAltForEncoding(wxFontEncoding encoding, // wxFontEncoding *alt_encoding, // const wxString& facename = wxEmptyString, // bool interactive = TRUE); // Find an alternative for the given encoding (which is supposed to not be // available on this system). If successful, returns the encoding otherwise // returns None. %addmethods { PyObject* GetAltForEncoding(wxFontEncoding encoding, const wxString& facename = wxEmptyString, bool interactive = TRUE) { wxFontEncoding alt_enc; if (self->GetAltForEncoding(encoding, &alt_enc, facename, interactive)) return PyInt_FromLong(alt_enc); else { Py_INCREF(Py_None); return Py_None; } } } // checks whether given encoding is available in given face or not. // If no facename is given, bool IsEncodingAvailable(wxFontEncoding encoding, const wxString& facename = wxEmptyString); // returns the encoding for the given charset (in the form of RFC 2046) or // wxFONTENCODING_SYSTEM if couldn't decode it wxFontEncoding CharsetToEncoding(const wxString& charset, bool interactive = TRUE); // return internal string identifier for the encoding (see also // GetEncodingDescription()) static wxString GetEncodingName(wxFontEncoding encoding); // return user-readable string describing the given encoding // // NB: hard-coded now, but might change later (read it from config?) static wxString GetEncodingDescription(wxFontEncoding encoding); // the parent window for modal dialogs void SetDialogParent(wxWindow *parent); // the title for the dialogs (note that default is quite reasonable) void SetDialogTitle(const wxString& title); // functions which allow to configure the config object used: by default, // the global one (from wxConfigBase::Get() will be used) and the default // root path for the config settings is the string returned by // GetDefaultConfigPath() // set the config object to use (may be NULL to use default) void SetConfig(wxConfigBase *config); // set the root config path to use (should be an absolute path) void SetConfigPath(const wxString& prefix); // return default config path static const wxChar *GetDefaultConfigPath(); }; class wxFont : public wxGDIObject { public: wxFont( int pointSize, int family, int style, int weight, int underline=FALSE, char* faceName = "", wxFontEncoding encoding=wxFONTENCODING_DEFAULT); %name(wxFontFromNativeInfo)wxFont(const wxNativeFontInfo& info); ~wxFont(); bool Ok() const; int GetPointSize() const; int GetFamily() const; int GetStyle() const; int GetWeight() const; bool GetUnderlined() const; wxString GetFaceName() const; wxFontEncoding GetEncoding() const; wxNativeFontInfo* GetNativeFontInfo() const; void SetPointSize(int pointSize); void SetFamily(int family); void SetStyle(int style); void SetWeight(int weight); void SetFaceName(const wxString& faceName); void SetUnderlined(bool underlined); void SetEncoding(wxFontEncoding encoding); void SetNativeFontInfo(const wxNativeFontInfo& info); wxString GetFamilyString() const; wxString GetStyleString() const; wxString GetWeightString() const; static wxFontEncoding GetDefaultEncoding(); static void SetDefaultEncoding(wxFontEncoding encoding); }; class wxFontList : public wxObject { public: void AddFont(wxFont* font); wxFont * FindOrCreateFont(int point_size, int family, int style, int weight, bool underline = FALSE, const char* facename = NULL, wxFontEncoding encoding = wxFONTENCODING_DEFAULT); void RemoveFont(wxFont *font); int GetCount(); }; //---------------------------------------------------------------------- class wxColour : public wxObject { public: wxColour(unsigned char red=0, unsigned char green=0, unsigned char blue=0); ~wxColour(); unsigned char Red(); unsigned char Green(); unsigned char Blue(); bool Ok(); void Set(unsigned char red, unsigned char green, unsigned char blue); %addmethods { PyObject* Get() { PyObject* rv = PyTuple_New(3); PyTuple_SetItem(rv, 0, PyInt_FromLong(self->Red())); PyTuple_SetItem(rv, 1, PyInt_FromLong(self->Green())); PyTuple_SetItem(rv, 2, PyInt_FromLong(self->Blue())); return rv; } } %pragma(python) addtoclass = "asTuple = Get" %pragma(python) addtoclass = "def __str__(self): return str(self.asTuple())" %pragma(python) addtoclass = "def __repr__(self): return str(self.asTuple())" }; %new wxColour* wxNamedColour(const wxString& colorName); %{ // Alternate 'constructor' wxColour* wxNamedColour(const wxString& colorName) { return new wxColour(colorName); } %} class wxColourDatabase : public wxObject { public: wxColour *FindColour(const wxString& colour); wxString FindName(const wxColour& colour) const; %addmethods { void Append(const wxString& name, int red, int green, int blue) { self->Append(name.c_str(), new wxColour(red, green, blue)); } } }; //---------------------------------------------------------------------- class wxPen : public wxGDIObject { public: wxPen(wxColour& colour, int width=1, int style=wxSOLID); ~wxPen(); int GetCap(); wxColour GetColour(); int GetJoin(); int GetStyle(); int GetWidth(); bool Ok(); void SetCap(int cap_style); void SetColour(wxColour& colour); void SetJoin(int join_style); void SetStyle(int style); void SetWidth(int width); // **** This one needs to return a list of ints (wxDash) //int GetDashes(wxDash **dashes); void SetDashes(int LCOUNT, wxDash* choices); #ifdef __WXMSW__ wxBitmap* GetStipple(); void SetStipple(wxBitmap& stipple); #endif }; // The list of ints for the dashes needs to exist for the life of the pen // so we make it part of the class to save it. wxPyPen is aliased to wxPen // in _extras.py %{ class wxPyPen : public wxPen { public: wxPyPen(wxColour& colour, int width=1, int style=wxSOLID) : wxPen(colour, width, style) { m_dash = NULL; } ~wxPyPen() { if (m_dash) delete [] m_dash; } void SetDashes(int nb_dashes, const wxDash *dash) { if (m_dash) delete [] m_dash; m_dash = new wxDash[nb_dashes]; for (int i=0; iGetPixel(x, y, wc); return wc; } } %name(GetSizeTuple)void GetSize(int* OUTPUT, int* OUTPUT); wxSize GetSize(); wxSize GetSizeMM(); wxColour GetTextBackground(); void GetTextExtent(const wxString& string, long *OUTPUT, long *OUTPUT); %name(GetFullTextExtent)void GetTextExtent(const wxString& string, long *OUTPUT, long *OUTPUT, long *OUTPUT, long* OUTPUT, const wxFont* font = NULL); wxColour GetTextForeground(); void GetUserScale(double *OUTPUT, double *OUTPUT); long LogicalToDeviceX(long x); long LogicalToDeviceXRel(long x); long LogicalToDeviceY(long y); long LogicalToDeviceYRel(long y); long MaxX(); long MaxY(); long MinX(); long MinY(); bool Ok(); void SetDeviceOrigin(long x, long y); void SetBackground(const wxBrush& brush); void SetBackgroundMode(int mode); void SetClippingRegion(long x, long y, long width, long height); %name(SetClippingRegionAsRegion) void SetClippingRegion(const wxRegion& region); void SetPalette(const wxPalette& colourMap); void SetBrush(const wxBrush& brush); void SetFont(const wxFont& font); void SetLogicalFunction(int function); void SetLogicalScale(double x, double y); void SetMapMode(int mode); void SetOptimization(bool optimize); void SetPen(const wxPen& pen); void SetTextBackground(const wxColour& colour); void SetTextForeground(const wxColour& colour); void SetUserScale(double x_scale, double y_scale); bool StartDoc(const wxString& message); void StartPage(); void DrawBitmap(const wxBitmap& bitmap, long x, long y, int useMask = FALSE); bool CanDrawBitmap(); bool CanGetTextExtent(); int GetDepth(); wxSize GetPPI(); void GetLogicalOrigin(int *OUTPUT, int *OUTPUT); void SetLogicalOrigin(int x, int y); void GetDeviceOrigin(int *OUTPUT, int *OUTPUT); void SetAxisOrientation(bool xLeftRight, bool yBottomUp); void CalcBoundingBox(int x, int y); void ResetBoundingBox(); %addmethods { void GetBoundingBox(int* OUTPUT, int* OUTPUT, int* OUTPUT, int* OUTPUT); // See below for implementation } #ifdef __WXMSW__ long GetHDC(); #endif %addmethods { // NOTE: These methods are VERY SIMILAR in implentation. It would be // nice to factor out common code and or turn them into a set of // template-like macros. // Draw a point for every set of coordinants in pyPoints, optionally // setting a new pen for each PyObject* _DrawPointList(PyObject* pyPoints, PyObject* pyPens) { bool isFastSeq = PyList_Check(pyPoints) || PyTuple_Check(pyPoints); bool isFastPens = PyList_Check(pyPens) || PyTuple_Check(pyPens); int numObjs = 0; int numPens = 0; wxPen* pen; PyObject* obj; int x1, y1; int i = 0; if (!PySequence_Check(pyPoints)) { goto err0; } if (!PySequence_Check(pyPens)) { goto err1; } numObjs = PySequence_Length(pyPoints); numPens = PySequence_Length(pyPens); for (i = 0; i < numObjs; i++) { // Use a new pen? if (i < numPens) { if (isFastPens) { obj = PySequence_Fast_GET_ITEM(pyPens, i); } else { obj = PySequence_GetItem(pyPens, i); } if (SWIG_GetPtrObj(obj, (void **) &pen, "_wxPen_p")) { if (!isFastPens) Py_DECREF(obj); goto err1; } self->SetPen(*pen); if (!isFastPens) Py_DECREF(obj); } // Get the point coordinants if (isFastSeq) { obj = PySequence_Fast_GET_ITEM(pyPoints, i); } else { obj = PySequence_GetItem(pyPoints, i); } if (! _2int_seq_helper(obj, &x1, &y1)) { if (!isFastPens) Py_DECREF(obj); goto err0; } // Now draw the point self->DrawPoint(x1, y1); if (!isFastSeq) Py_DECREF(obj); } Py_INCREF(Py_None); return Py_None; err1: PyErr_SetString(PyExc_TypeError, "Expected a sequence of wxPens"); return NULL; err0: PyErr_SetString(PyExc_TypeError, "Expected a sequence of (x,y) sequences."); return NULL; } // Draw a line for every set of coordinants in pyLines, optionally // setting a new pen for each PyObject* _DrawLineList(PyObject* pyLines, PyObject* pyPens) { bool isFastSeq = PyList_Check(pyLines) || PyTuple_Check(pyLines); bool isFastPens = PyList_Check(pyPens) || PyTuple_Check(pyPens); int numObjs = 0; int numPens = 0; wxPen* pen; PyObject* obj; int x1, y1, x2, y2; int i = 0; if (!PySequence_Check(pyLines)) { goto err0; } if (!PySequence_Check(pyPens)) { goto err1; } numObjs = PySequence_Length(pyLines); numPens = PySequence_Length(pyPens); for (i = 0; i < numObjs; i++) { // Use a new pen? if (i < numPens) { if (isFastPens) { obj = PySequence_Fast_GET_ITEM(pyPens, i); } else { obj = PySequence_GetItem(pyPens, i); } if (SWIG_GetPtrObj(obj, (void **) &pen, "_wxPen_p")) { if (!isFastPens) Py_DECREF(obj); goto err1; } self->SetPen(*pen); if (!isFastPens) Py_DECREF(obj); } // Get the line coordinants if (isFastSeq) { obj = PySequence_Fast_GET_ITEM(pyLines, i); } else { obj = PySequence_GetItem(pyLines, i); } if (! _4int_seq_helper(obj, &x1, &y1, &x2, &y2)) { if (!isFastPens) Py_DECREF(obj); goto err0; } // Now draw the line self->DrawLine(x1, y1, x2, y2); if (!isFastSeq) Py_DECREF(obj); } Py_INCREF(Py_None); return Py_None; err1: PyErr_SetString(PyExc_TypeError, "Expected a sequence of wxPens"); return NULL; err0: PyErr_SetString(PyExc_TypeError, "Expected a sequence of (x1,y1, x2,y2) sequences."); return NULL; } } %pragma(python) addtoclass = " def DrawPointList(self, points, pens=None): if pens is None: pens = [] elif isinstance(pens, wxPenPtr): pens = [pens] elif len(pens) != len(points): raise ValueError('points and pens must have same length') return self._DrawPointList(points, pens) def DrawLineList(self, lines, pens=None): if pens is None: pens = [] elif isinstance(pens, wxPenPtr): pens = [pens] elif len(pens) != len(lines): raise ValueError('lines and pens must have same length') return self._DrawLineList(lines, pens) " }; %{ static void wxDC_GetBoundingBox(wxDC* dc, int* x1, int* y1, int* x2, int* y2) { *x1 = dc->MinX(); *y1 = dc->MinY(); *x2 = dc->MaxX(); *y2 = dc->MaxY(); } %} //---------------------------------------------------------------------- class wxMemoryDC : public wxDC { public: wxMemoryDC(); void SelectObject(const wxBitmap& bitmap); } %new wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC); %{ // Alternate 'constructor' wxMemoryDC* wxMemoryDCFromDC(wxDC* oldDC) { return new wxMemoryDC(oldDC); } %} //--------------------------------------------------------------------------- class wxScreenDC : public wxDC { public: wxScreenDC(); %name(StartDrawingOnTopWin) bool StartDrawingOnTop(wxWindow* window); bool StartDrawingOnTop(wxRect* rect = NULL); bool EndDrawingOnTop(); }; //--------------------------------------------------------------------------- class wxClientDC : public wxDC { public: wxClientDC(wxWindow* win); }; //--------------------------------------------------------------------------- class wxPaintDC : public wxDC { public: wxPaintDC(wxWindow* win); }; //--------------------------------------------------------------------------- class wxWindowDC : public wxDC { public: wxWindowDC(wxWindow* win); }; //--------------------------------------------------------------------------- #ifdef __WXMSW__ %{ #include %} class wxMetaFile : public wxObject { public: wxMetaFile(const wxString& filename = wxPyEmptyStr); ~wxMetaFile(); bool Ok(); bool SetClipboard(int width = 0, int height = 0); wxSize GetSize(); int GetWidth(); int GetHeight(); const wxString& GetFileName() const { return m_filename; } }; // bool wxMakeMetaFilePlaceable(const wxString& filename, // int minX, int minY, int maxX, int maxY, float scale=1.0); class wxMetaFileDC : public wxDC { public: wxMetaFileDC(const wxString& filename = wxPyEmptyStr, int width = 0, int height = 0, const wxString& description = wxPyEmptyStr); wxMetaFile* Close(); }; #endif //--------------------------------------------------------------------------- class wxPalette : public wxGDIObject { public: wxPalette(int LCOUNT, byte* choices, byte* choices, byte* choices); ~wxPalette(); int GetPixel(byte red, byte green, byte blue); bool GetRGB(int pixel, byte* OUTPUT, byte* OUTPUT, byte* OUTPUT); bool Ok(); }; //--------------------------------------------------------------------------- enum { wxIMAGELIST_DRAW_NORMAL , wxIMAGELIST_DRAW_TRANSPARENT, wxIMAGELIST_DRAW_SELECTED, wxIMAGELIST_DRAW_FOCUSED, wxIMAGE_LIST_NORMAL, wxIMAGE_LIST_SMALL, wxIMAGE_LIST_STATE }; class wxImageList : public wxObject { public: wxImageList(int width, int height, int mask=TRUE, int initialCount=1); ~wxImageList(); int Add(const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap); %name(AddWithColourMask)int Add(const wxBitmap& bitmap, const wxColour& maskColour); %name(AddIcon)int Add(const wxIcon& icon); #ifdef __WXMSW__ bool Replace(int index, const wxBitmap& bitmap, const wxBitmap& mask = wxNullBitmap); #else // %name(ReplaceIcon)bool Replace(int index, const wxIcon& icon); // int Add(const wxBitmap& bitmap); bool Replace(int index, const wxBitmap& bitmap); #endif bool Draw(int index, wxDC& dc, int x, int x, int flags = wxIMAGELIST_DRAW_NORMAL, const bool solidBackground = FALSE); int GetImageCount(); bool Remove(int index); bool RemoveAll(); void GetSize(int index, int& OUTPUT, int& OUTPUT); }; //--------------------------------------------------------------------------- // Regions, etc. enum wxRegionContain { wxOutRegion, wxPartRegion, wxInRegion }; class wxRegion : public wxGDIObject { public: wxRegion(long x=0, long y=0, long width=0, long height=0); ~wxRegion(); void Clear(); wxRegionContain Contains(long x, long y); %name(ContainsPoint)wxRegionContain Contains(const wxPoint& pt); %name(ContainsRect)wxRegionContain Contains(const wxRect& rect); %name(ContainsRectDim)wxRegionContain Contains(long x, long y, long w, long h); wxRect GetBox(); bool Intersect(long x, long y, long width, long height); %name(IntersectRect)bool Intersect(const wxRect& rect); %name(IntersectRegion)bool Intersect(const wxRegion& region); bool IsEmpty(); bool Union(long x, long y, long width, long height); %name(UnionRect)bool Union(const wxRect& rect); %name(UnionRegion)bool Union(const wxRegion& region); bool Subtract(long x, long y, long width, long height); %name(SubtractRect)bool Subtract(const wxRect& rect); %name(SubtractRegion)bool Subtract(const wxRegion& region); bool Xor(long x, long y, long width, long height); %name(XorRect)bool Xor(const wxRect& rect); %name(XorRegion)bool Xor(const wxRegion& region); }; class wxRegionIterator : public wxObject { public: wxRegionIterator(const wxRegion& region); ~wxRegionIterator(); long GetX(); long GetY(); long GetW(); long GetWidth(); long GetH(); long GetHeight(); wxRect GetRect(); bool HaveRects(); void Reset(); %addmethods { void Next() { (*self) ++; } }; }; //--------------------------------------------------------------------------- %readonly %{ #if 0 %} extern wxFont *wxNORMAL_FONT; extern wxFont *wxSMALL_FONT; extern wxFont *wxITALIC_FONT; extern wxFont *wxSWISS_FONT; extern wxPen *wxRED_PEN; extern wxPen *wxCYAN_PEN; extern wxPen *wxGREEN_PEN; extern wxPen *wxBLACK_PEN; extern wxPen *wxWHITE_PEN; extern wxPen *wxTRANSPARENT_PEN; extern wxPen *wxBLACK_DASHED_PEN; extern wxPen *wxGREY_PEN; extern wxPen *wxMEDIUM_GREY_PEN; extern wxPen *wxLIGHT_GREY_PEN; extern wxBrush *wxBLUE_BRUSH; extern wxBrush *wxGREEN_BRUSH; extern wxBrush *wxWHITE_BRUSH; extern wxBrush *wxBLACK_BRUSH; extern wxBrush *wxTRANSPARENT_BRUSH; extern wxBrush *wxCYAN_BRUSH; extern wxBrush *wxRED_BRUSH; extern wxBrush *wxGREY_BRUSH; extern wxBrush *wxMEDIUM_GREY_BRUSH; extern wxBrush *wxLIGHT_GREY_BRUSH; extern wxColour *wxBLACK; extern wxColour *wxWHITE; extern wxColour *wxRED; extern wxColour *wxBLUE; extern wxColour *wxGREEN; extern wxColour *wxCYAN; extern wxColour *wxLIGHT_GREY; extern wxCursor *wxSTANDARD_CURSOR; extern wxCursor *wxHOURGLASS_CURSOR; extern wxCursor *wxCROSS_CURSOR; extern wxBitmap wxNullBitmap; extern wxIcon wxNullIcon; extern wxCursor wxNullCursor; extern wxPen wxNullPen; extern wxBrush wxNullBrush; extern wxPalette wxNullPalette; extern wxFont wxNullFont; extern wxColour wxNullColour; extern wxFontList* wxTheFontList; extern wxPenList* wxThePenList; extern wxBrushList* wxTheBrushList; extern wxColourDatabase* wxTheColourDatabase; %readwrite %{ #endif %} //--------------------------------------------------------------------------- //---------------------------------------------------------------------------