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
  23 //---------------------------------------------------------------------------
  24 %newgroup
  25
  26 MustHaveApp(wxStaticBox);
  27
  28 class wxStaticBox : public wxControl {
  29 public:
  30     %pythonAppend wxStaticBox         "self._setOORInfo(self)"
  31     %pythonAppend wxStaticBox()       ""
  32     %typemap(out) wxStaticBox*;    // turn off this typemap
  33
  34     wxStaticBox(wxWindow* parent, wxWindowID id=-1,
  35                 const wxString& label = wxPyEmptyString,
  36                 const wxPoint& pos = wxDefaultPosition,
  37                 const wxSize& size = wxDefaultSize,
  38                 long style = 0,
  39                 const wxString& name = wxPyStaticBoxNameStr);
  40     %RenameCtor(PreStaticBox, wxStaticBox());
  41
  42     // Turn it back on again
  43     %typemap(out) wxStaticBox* { $result = wxPyMake_wxObject($1, $owner); }
  44
  45     bool Create(wxWindow* parent, wxWindowID id=-1,
  46                 const wxString& label = wxPyEmptyString,
  47                 const wxPoint& pos = wxDefaultPosition,
  48                 const wxSize& size = wxDefaultSize,
  49                 long style = 0,
  50                 const wxString& name = wxPyStaticBoxNameStr);
  51
  52     static wxVisualAttributes
  53     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  54 };
  55
  56
  57 //---------------------------------------------------------------------------
  58 %newgroup
  59
  60
  61 MustHaveApp(wxStaticLine);
  62
  63 class wxStaticLine : public wxControl {
  64 public:
  65     %pythonAppend wxStaticLine         "self._setOORInfo(self)"
  66     %pythonAppend wxStaticLine()       ""
  67
  68     wxStaticLine( wxWindow *parent, wxWindowID id=-1,
  69                   const wxPoint &pos = wxDefaultPosition,
  70                   const wxSize &size = wxDefaultSize,
  71                   long style = wxLI_HORIZONTAL,
  72                   const wxString& name = wxPyStaticTextNameStr);
  73     %RenameCtor(PreStaticLine, wxStaticLine());
  74
  75     bool Create( wxWindow *parent, wxWindowID id=-1,
  76                   const wxPoint &pos = wxDefaultPosition,
  77                   const wxSize &size = wxDefaultSize,
  78                   long style = wxLI_HORIZONTAL,
  79                   const wxString& name = wxPyStaticTextNameStr);
  80
  81     // is the line vertical?
  82     bool IsVertical() const;
  83
  84     // get the default size for the "lesser" dimension of the static line
  85     static int GetDefaultSize();
  86
  87     static wxVisualAttributes
  88     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  89 };
  90
  91
  92 //---------------------------------------------------------------------------
  93 %newgroup
  94
  95 MustHaveApp(wxStaticText);
  96
  97 class wxStaticText : public wxControl {
  98 public:
  99     %pythonAppend wxStaticText         "self._setOORInfo(self)"
 100     %pythonAppend wxStaticText()       ""
 101
 102     wxStaticText(wxWindow* parent, wxWindowID id=-1,
 103                  const wxString& label = wxPyEmptyString,
 104                  const wxPoint& pos = wxDefaultPosition,
 105                  const wxSize& size = wxDefaultSize,
 106                  long style = 0,
 107                  const wxString& name = wxPyStaticTextNameStr);
 108     %RenameCtor(PreStaticText, wxStaticText());
 109
 110     bool Create(wxWindow* parent, wxWindowID id=-1,
 111                 const wxString& label = wxPyEmptyString,
 112                  const wxPoint& pos = wxDefaultPosition,
 113                  const wxSize& size = wxDefaultSize,
 114                  long style = 0,
 115                  const wxString& name = wxPyStaticTextNameStr);
 116
 117     DocDeclStr(
 118         void , Wrap(int width),
 119         "This functions wraps the control's label so that each of its lines
 120 becomes at most ``width`` pixels wide if possible (the lines are
 121 broken at words boundaries so it might not be the case if words are
 122 too long). If ``width`` is negative, no wrapping is done.", "");
 123
 124
 125     static wxVisualAttributes
 126     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 127 };
 128
 129 //---------------------------------------------------------------------------
 130 %newgroup
 131
 132 MustHaveApp(wxStaticBitmap);
 133
 134 class wxStaticBitmap : public wxControl {
 135 public:
 136     %pythonAppend wxStaticBitmap         "self._setOORInfo(self)"
 137     %pythonAppend wxStaticBitmap()       ""
 138
 139     wxStaticBitmap(wxWindow* parent, wxWindowID id=-1,
 140                    const wxBitmap& bitmap = wxNullBitmap,
 141                    const wxPoint& pos = wxDefaultPosition,
 142                    const wxSize& size = wxDefaultSize,
 143                    long style = 0,
 144                    const wxString& name = wxPyStaticBitmapNameStr);
 145     %RenameCtor(PreStaticBitmap, wxStaticBitmap());
 146
 147     bool Create(wxWindow* parent, wxWindowID id=-1,
 148                    const wxBitmap& bitmap = wxNullBitmap,
 149                    const wxPoint& pos = wxDefaultPosition,
 150                    const wxSize& size = wxDefaultSize,
 151                    long style = 0,
 152                    const wxString& name = wxPyStaticBitmapNameStr);
 153
 154     wxBitmap GetBitmap();
 155     void SetBitmap(const wxBitmap& bitmap);
 156     void SetIcon(const wxIcon& icon);
 157
 158     static wxVisualAttributes
 159     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 160 };
 161
 162 //---------------------------------------------------------------------------
 163 //---------------------------------------------------------------------------