]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_statusbar.i
docstring patch has been submitted to SF
[wxWidgets.git] / wxPython / src / _statusbar.i
CommitLineData
d14a1e28
RD
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// wxStatusBar: a window near the bottom of the frame used for status info
26class wxStatusBar : public wxWindow
27{
28public:
29 %addtofunc wxStatusBar "self._setOORInfo(self)"
30 %addtofunc wxStatusBar() ""
31
32 wxStatusBar(wxWindow* parent, wxWindowID id = -1,
33 long style = wxST_SIZEGRIP,
34 const wxString& name = wxPyStatusLineNameStr);
35 %name(PreStatusBar)wxStatusBar();
36
37 bool Create(wxWindow* parent, wxWindowID id,
38 long style = wxST_SIZEGRIP,
39 const wxString& name = wxPyStatusLineNameStr);
40
41 // set the number of fields and call SetStatusWidths(widths) if widths are
42 // given
43 virtual void SetFieldsCount(int number = 1 /*, const int *widths = NULL*/);
44 int GetFieldsCount() const;
45
46 virtual void SetStatusText(const wxString& text, int number = 0);
47 virtual wxString GetStatusText(int number = 0) const;
48
49 void PushStatusText(const wxString& text, int number = 0);
50 void PopStatusText(int number = 0);
51
52
53 // set status field widths as absolute numbers: positive widths mean that
54 // the field has the specified absolute width, negative widths are
55 // interpreted as the sizer options, i.e. the extra space (total space
56 // minus the sum of fixed width fields) is divided between the fields with
57 // negative width according to the abs value of the width (field with width
58 // -2 grows twice as much as one with width -1 &c)
59 virtual void SetStatusWidths(int widths, const int* widths_field); // uses typemap in _toplvl.i
60
61 // Get the position and size of the field's internal bounding rectangle
7722248d
RD
62 %extend {
63 wxRect GetFieldRect(int i) {
64 wxRect r;
65 self->GetFieldRect(i, r);
66 return r;
67 }
68 }
69
d14a1e28
RD
70 // sets the minimal vertical size of the status bar
71 virtual void SetMinHeight(int height);
72
73 // get the dimensions of the horizontal and vertical borders
74 virtual int GetBorderX() const;
75 virtual int GetBorderY() const;
76};
77
78
79//---------------------------------------------------------------------------