X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dce2bd223c2370f001f9ca93e04cbd437ff3f988..f6342fb5e6524edffa219d5843536ea279bba4df:/wxPython/src/_brush.i diff --git a/wxPython/src/_brush.i b/wxPython/src/_brush.i index 45503e817f..e990a3b94c 100644 --- a/wxPython/src/_brush.i +++ b/wxPython/src/_brush.i @@ -19,7 +19,7 @@ DocStr(wxBrush, "A brush is a drawing tool for filling in areas. It is used for painting the background of rectangles, ellipses, etc. when drawing on -a `wx.DC`. It has a colour and a style. +a `wx.DC`. It has a colour and a style.", " :warning: Do not create instances of wx.Brush before the `wx.App` object has been created because, depending on the platform, @@ -33,12 +33,14 @@ a `wx.DC`. It has a colour and a style. :see: `wx.BrushList`, `wx.DC`, `wx.DC.SetBrush` "); +MustHaveApp(wxBrush); + class wxBrush : public wxGDIObject { public: DocCtorStr( wxBrush(const wxColour& colour, int style=wxSOLID), - "Constructs a brush from a `wx.Colour` object and a style. The style -parameter may be one of the following: + "Constructs a brush from a `wx.Colour` object and a style.", + "The style parameter may be one of the following: =================== ============================= Style Meaning @@ -54,43 +56,55 @@ parameter may be one of the following: wx.VERTICAL_HATCH Vertical hatch. =================== ============================= +:see: `wx.BrushFromBitmap` "); + DocCtorStrName( + wxBrush(const wxBitmap& stippleBitmap), + "Constructs a stippled brush using a bitmap.", "", + BrushFromBitmap); + ~wxBrush(); DocDeclStr( virtual void , SetColour(const wxColour& col), - "Set the brush's `wx.Colour`."); + "Set the brush's `wx.Colour`.", ""); DocDeclStr( virtual void , SetStyle(int style), - "Sets the style of the brush. See `__init__` for a listing of styles."); + "Sets the style of the brush. See `__init__` for a listing of styles.", ""); DocDeclStr( virtual void , SetStipple(const wxBitmap& stipple), - "Sets the stipple `wx.Bitmap`."); + "Sets the stipple `wx.Bitmap`.", ""); DocDeclStr( wxColour , GetColour() const, - "Returns the `wx.Colour` of the brush."); + "Returns the `wx.Colour` of the brush.", ""); DocDeclStr( int , GetStyle() const, "Returns the style of the brush. See `__init__` for a listing of -styles."); +styles.", ""); DocDeclStr( wxBitmap *, GetStipple() const, "Returns the stiple `wx.Bitmap` of the brush. If the brush does not have a wx.STIPPLE style, then the return value may be non-None but an -uninitialised bitmap (`wx.Bitmap.Ok` returns False)."); +uninitialised bitmap (`wx.Bitmap.Ok` returns False).", ""); + + DocDeclStr( + bool , IsHatch() const, + "Is the current style a hatch type?", ""); + DocDeclStr( - bool , Ok(), - "Returns True if the brush is initialised and valid."); + bool , IsOk(), + "Returns True if the brush is initialised and valid.", ""); + %pythoncode { Ok = IsOk } #ifdef __WXMAC__ @@ -98,7 +112,12 @@ uninitialised bitmap (`wx.Bitmap.Ok` returns False)."); void MacSetTheme(short macThemeBrush); #endif - %pythoncode { def __nonzero__(self): return self.Ok() } + %pythoncode { def __nonzero__(self): return self.IsOk() } + + %property(Colour, GetColour, SetColour, doc="See `GetColour` and `SetColour`"); + %property(Stipple, GetStipple, SetStipple, doc="See `GetStipple` and `SetStipple`"); + %property(Style, GetStyle, SetStyle, doc="See `GetStyle` and `SetStyle`"); + }; //---------------------------------------------------------------------------