wxPython/src/_statctrls.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _statctrls.i
   3 // Purpose:     SWIG interface defs for wxStaticBox, wxStaticLine,
   4 //              wxStaticText, wxStaticBitmap
   5 //
   6 // Author:      Robin Dunn
   7 //
   8 // Created:     10-June-1998
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) 2003 by Total Control Software
  11 // Licence:     wxWindows license
  12 /////////////////////////////////////////////////////////////////////////////
  13
  14 // Not a %module
  15
  16
  17 //---------------------------------------------------------------------------
  18
  19 MAKE_CONST_WXSTRING(StaticBitmapNameStr);
  20 MAKE_CONST_WXSTRING(StaticBoxNameStr);
  21 MAKE_CONST_WXSTRING(StaticTextNameStr);
  22 MAKE_CONST_WXSTRING(StaticLineNameStr);
  23
  24 //---------------------------------------------------------------------------
  25 %newgroup
  26
  27 MustHaveApp(wxStaticBox);
  28
  29 class wxStaticBox : public wxControl {
  30 public:
  31     %pythonAppend wxStaticBox         "self._setOORInfo(self)"
  32     %pythonAppend wxStaticBox()       ""
  33     %typemap(out) wxStaticBox*;    // turn off this typemap
  34
  35     wxStaticBox(wxWindow* parent, wxWindowID id=-1,
  36                 const wxString& label = wxPyEmptyString,
  37                 const wxPoint& pos = wxDefaultPosition,
  38                 const wxSize& size = wxDefaultSize,
  39                 long style = 0,
  40                 const wxString& name = wxPyStaticBoxNameStr);
  41     %RenameCtor(PreStaticBox, wxStaticBox());
  42
  43     // Turn it back on again
  44     %typemap(out) wxStaticBox* { $result = wxPyMake_wxObject($1, $owner); }
  45
  46     bool Create(wxWindow* parent, wxWindowID id=-1,
  47                 const wxString& label = wxPyEmptyString,
  48                 const wxPoint& pos = wxDefaultPosition,
  49                 const wxSize& size = wxDefaultSize,
  50                 long style = 0,
  51                 const wxString& name = wxPyStaticBoxNameStr);
  52
  53     static wxVisualAttributes
  54     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  55 };
  56
  57
  58 //---------------------------------------------------------------------------
  59 %newgroup
  60
  61
  62 MustHaveApp(wxStaticLine);
  63
  64 class wxStaticLine : public wxControl {
  65 public:
  66     %pythonAppend wxStaticLine         "self._setOORInfo(self)"
  67     %pythonAppend wxStaticLine()       ""
  68
  69     wxStaticLine( wxWindow *parent, wxWindowID id=-1,
  70                   const wxPoint &pos = wxDefaultPosition,
  71                   const wxSize &size = wxDefaultSize,
  72                   long style = wxLI_HORIZONTAL,
  73                   const wxString& name = wxPyStaticLineNameStr);
  74     %RenameCtor(PreStaticLine, wxStaticLine());
  75
  76     bool Create( wxWindow *parent, wxWindowID id=-1,
  77                   const wxPoint &pos = wxDefaultPosition,
  78                   const wxSize &size = wxDefaultSize,
  79                   long style = wxLI_HORIZONTAL,
  80                   const wxString& name = wxPyStaticLineNameStr);
  81
  82     // is the line vertical?
  83     bool IsVertical() const;
  84
  85     // get the default size for the "lesser" dimension of the static line
  86     static int GetDefaultSize();
  87
  88     static wxVisualAttributes
  89     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  90 };
  91
  92
  93 //---------------------------------------------------------------------------
  94 %newgroup
  95
  96 MustHaveApp(wxStaticText);
  97
  98 enum {
  99     wxST_NO_AUTORESIZE,
 100     wxST_MARKUP,
 101
 102     wxST_ELLIPSIZE_START,
 103     wxST_ELLIPSIZE_MIDDLE,
 104     wxST_ELLIPSIZE_END
 105 };
 106
 107
 108 class wxStaticText : public wxControl {
 109 public:
 110     %pythonAppend wxStaticText         "self._setOORInfo(self)"
 111     %pythonAppend wxStaticText()       ""
 112
 113     wxStaticText(wxWindow* parent, wxWindowID id=-1,
 114                  const wxString& label = wxPyEmptyString,
 115                  const wxPoint& pos = wxDefaultPosition,
 116                  const wxSize& size = wxDefaultSize,
 117                  long style = 0,
 118                  const wxString& name = wxPyStaticTextNameStr);
 119     %RenameCtor(PreStaticText, wxStaticText());
 120
 121     bool Create(wxWindow* parent, wxWindowID id=-1,
 122                 const wxString& label = wxPyEmptyString,
 123                  const wxPoint& pos = wxDefaultPosition,
 124                  const wxSize& size = wxDefaultSize,
 125                  long style = 0,
 126                  const wxString& name = wxPyStaticTextNameStr);
 127
 128     DocDeclStr(
 129         void , Wrap(int width),
 130         "This functions wraps the control's label so that each of its lines
 131 becomes at most ``width`` pixels wide if possible (the lines are
 132 broken at words boundaries so it might not be the case if words are
 133 too long). If ``width`` is negative, no wrapping is done.", "");
 134
 135     bool IsEllipsized() const;
 136
 137     DocDeclStr(
 138         static wxString , RemoveMarkup(const wxString& str),
 139         "Removes the markup accepted by wx.StaticText when wx.ST_MARKUP is
 140 used, and then returns the cleaned string.
 141     ", "");
 142
 143
 144     DocDeclStr(
 145         static wxString , EscapeMarkup(const wxString& str),
 146         "Escapes the alls special symbols (<>\"\'&) present inside the given
 147 string using the corresponding entities (&lt; &gt; &quot; &apos;
 148 &amp;)", "");
 149
 150
 151     static wxVisualAttributes
 152     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 153 };
 154
 155 //---------------------------------------------------------------------------
 156 %newgroup
 157
 158 MustHaveApp(wxStaticBitmap);
 159
 160 class wxStaticBitmap : public wxControl {
 161 public:
 162     %pythonAppend wxStaticBitmap         "self._setOORInfo(self)"
 163     %pythonAppend wxStaticBitmap()       ""
 164
 165     wxStaticBitmap(wxWindow* parent, wxWindowID id=-1,
 166                    const wxBitmap& bitmap = wxNullBitmap,
 167                    const wxPoint& pos = wxDefaultPosition,
 168                    const wxSize& size = wxDefaultSize,
 169                    long style = 0,
 170                    const wxString& name = wxPyStaticBitmapNameStr);
 171     %RenameCtor(PreStaticBitmap, wxStaticBitmap());
 172
 173     bool Create(wxWindow* parent, wxWindowID id=-1,
 174                    const wxBitmap& bitmap = wxNullBitmap,
 175                    const wxPoint& pos = wxDefaultPosition,
 176                    const wxSize& size = wxDefaultSize,
 177                    long style = 0,
 178                    const wxString& name = wxPyStaticBitmapNameStr);
 179
 180     wxBitmap GetBitmap();
 181     void SetBitmap(const wxBitmap& bitmap);
 182     void SetIcon(const wxIcon& icon);
 183
 184     static wxVisualAttributes
 185     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 186 };
 187
 188 //---------------------------------------------------------------------------
 189 //---------------------------------------------------------------------------