projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| c89165a8 VZ |
1 | \section{\class{wxStaticLine}}\label{wxstaticline} |
| 2 | ||
| 3 | A static line is just a line which may be used in a dialog to separate the | |
| 4 | groups of controls. The line may be only vertical or horizontal. | |
| 5 | ||
| 6 | \wxheading{Derived from} | |
| 7 | ||
| 8 | \helpref{wxControl}{wxcontrol}\\ | |
| 9 | \helpref{wxWindow}{wxwindow}\\ | |
| 10 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
| 11 | \helpref{wxObject}{wxobject} | |
| 12 | ||
| 13 | \wxheading{Include files} | |
| 14 | ||
| 15 | <wx/statline.h> | |
| 16 | ||
| 17 | \wxheading{Window styles} | |
| 18 | ||
| 19 | \twocolwidtha{5cm} | |
| 20 | \begin{twocollist}\itemsep=0pt | |
| 21 | \twocolitem{\windowstyle{wxLI\_HORIZONTAL}}{Creates a horizontal line.} | |
| 22 | \twocolitem{\windowstyle{wxLI\_VERTICAL}}{Creates a vertical line.} | |
| 23 | \end{twocollist} | |
| 24 | ||
| 25 | \wxheading{See also} | |
| 26 | ||
| 27 | \helpref{wxStaticBox}{wxstaticbox} | |
| 28 | ||
| 29 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 30 | ||
| 31 | \membersection{wxStaticLine::wxStaticLine}\label{wxstaticlinector} | |
| 32 | ||
| 33 | \func{}{wxStaticLine}{\void} | |
| 34 | ||
| 35 | Default constructor. | |
| 36 | ||
| 37 | \func{}{wxStaticLine}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp | |
| 38 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp | |
| 39 | \param{long}{ style = wxLI\_HORIZONTAL}, \param{const wxString\& }{name = ``staticLine"}} | |
| 40 | ||
| 41 | Constructor, creating and showing a static line. | |
| 42 | ||
| 43 | \wxheading{Parameters} | |
| 44 | ||
| 45 | \docparam{parent}{Parent window. Must not be NULL.} | |
| 46 | ||
| 47 | \docparam{id}{Window identifier. A value of -1 indicates a default value.} | |
| 48 | ||
| 49 | \docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.} | |
| 50 | ||
| 51 | \docparam{size}{Size. Note that either the height or the width (depending on | |
| 52 | whether the line if horizontal or vertical) is ignored.} | |
| 53 | ||
| 54 | \docparam{style}{Window style (either wxLI\_HORIZONTAL or wxLI\_VERTICAL).} | |
| 55 | ||
| 56 | \docparam{name}{Window name.} | |
| 57 | ||
| 58 | \wxheading{See also} | |
| 59 | ||
| 60 | \helpref{wxStaticLine::Create}{wxstaticlinecreate} | |
| 61 | ||
| 62 | \membersection{wxStaticLine::Create}\label{wxstaticlinecreate} | |
| 63 | ||
| 64 | \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{const wxString\& }{label},\rtfsp | |
| 65 | \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp | |
| 66 | \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticLine"}} | |
| 67 | ||
| 68 | Creates the static line for two-step construction. See \helpref{wxStaticLine::wxStaticLine}{wxstaticlinector}\rtfsp | |
| 69 | for further details. | |
| 70 | ||
| 71 | \membersection{wxStaticLine::IsVertical}\label{wxstaticlineisvertical} | |
| 72 | ||
| 73 | \constfunc{bool}{IsVertical}{\void} | |
| 74 | ||
| 75 | Returns TRUE if the line is vertical, FALSE if horizontal. | |
| 76 | ||
| 77 | \membersection{wxStaticLine::GetDefaultSize}\label{wxstaticlinegetdefaultsize} | |
| 78 | ||
| 79 | \func{int}{GetDefaultSize}{\void} | |
| 80 | ||
| 154f22b3 | 81 | This static function returns the size which will be given to the smaller |
| c89165a8 VZ |
82 | dimension of the static line, i.e. its height for a horizontal line or its |
| 83 | width for a vertical one. | |
| 22d6efa8 | 84 |