wxPython/src/_statusbar.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _statusbar.i
   3 // Purpose:     SWIG interface defs for wxStatusBar
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     24-Aug-1998
   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 %}
  20
  21 //---------------------------------------------------------------------------
  22 %newgroup;
  23
  24
  25
  26 // wxStatusBar: a window near the bottom of the frame used for status info
  27 MustHaveApp(wxStatusBar);
  28 class wxStatusBar : public wxWindow
  29 {
  30 public:
  31     %pythonAppend wxStatusBar         "self._setOORInfo(self)"
  32     %pythonAppend wxStatusBar()       ""
  33     %typemap(out) wxStatusBar*;    // turn off this typemap
  34
  35     wxStatusBar(wxWindow* parent, wxWindowID id = -1,
  36                 long style = wxDEFAULT_STATUSBAR_STYLE,
  37                 const wxString& name = wxPyStatusLineNameStr);
  38     %name(PreStatusBar)wxStatusBar();
  39
  40     // Turn it back on again
  41     %typemap(out) wxStatusBar* { $result = wxPyMake_wxObject($1, $owner); }
  42
  43     bool Create(wxWindow* parent, wxWindowID id=-1,
  44                 long style = wxST_SIZEGRIP,
  45                 const wxString& name = wxPyStatusLineNameStr);
  46
  47     // set the number of fields and call SetStatusWidths(widths) if widths are
  48     // given
  49     virtual void SetFieldsCount(int number = 1 /*, const int *widths = NULL*/);
  50     int GetFieldsCount() const;
  51
  52     virtual void SetStatusText(const wxString& text, int number = 0);
  53     virtual wxString GetStatusText(int number = 0) const;
  54
  55     void PushStatusText(const wxString& text, int number = 0);
  56     void PopStatusText(int number = 0);
  57
  58
  59     // set status field widths as absolute numbers: positive widths mean that
  60     // the field has the specified absolute width, negative widths are
  61     // interpreted as the sizer options, i.e. the extra space (total space
  62     // minus the sum of fixed width fields) is divided between the fields with
  63     // negative width according to the abs value of the width (field with width
  64     // -2 grows twice as much as one with width -1 &c)
  65     virtual void SetStatusWidths(int widths, const int* widths_field); // uses typemap in _toplvl.i
  66
  67     // Get the position and size of the field's internal bounding rectangle
  68     %extend {
  69         wxRect GetFieldRect(int i) {
  70             wxRect r;
  71             self->GetFieldRect(i, r);
  72             return r;
  73         }
  74     }
  75
  76     // sets the minimal vertical size of the status bar
  77     virtual void SetMinHeight(int height);
  78
  79     // get the dimensions of the horizontal and vertical borders
  80     virtual int GetBorderX() const;
  81     virtual int GetBorderY() const;
  82
  83     static wxVisualAttributes
  84     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  85 };
  86
  87
  88 //---------------------------------------------------------------------------