]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/statline.tex
cleanup
[wxWidgets.git] / docs / latex / wx / statline.tex
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{Library}
18
19 \helpref{wxCore}{librarieslist}
20
21 \wxheading{Window styles}
22
23 \twocolwidtha{5cm}
24 \begin{twocollist}\itemsep=0pt
25 \twocolitem{\windowstyle{wxLI\_HORIZONTAL}}{Creates a horizontal line.}
26 \twocolitem{\windowstyle{wxLI\_VERTICAL}}{Creates a vertical line.}
27 \end{twocollist}
28
29 \wxheading{See also}
30
31 \helpref{wxStaticBox}{wxstaticbox}
32
33 \latexignore{\rtfignore{\wxheading{Members}}}
34
35 \membersection{wxStaticLine::wxStaticLine}\label{wxstaticlinector}
36
37 \func{}{wxStaticLine}{\void}
38
39 Default constructor.
40
41 \func{}{wxStaticLine}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY},\rtfsp
42 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
43 \param{long}{ style = wxLI\_HORIZONTAL}, \param{const wxString\& }{name = ``staticLine"}}
44
45 Constructor, creating and showing a static line.
46
47 \wxheading{Parameters}
48
49 \docparam{parent}{Parent window. Must not be NULL.}
50
51 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
52
53 \docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
54
55 \docparam{size}{Size. Note that either the height or the width (depending on
56 whether the line if horizontal or vertical) is ignored.}
57
58 \docparam{style}{Window style (either wxLI\_HORIZONTAL or wxLI\_VERTICAL).}
59
60 \docparam{name}{Window name.}
61
62 \wxheading{See also}
63
64 \helpref{wxStaticLine::Create}{wxstaticlinecreate}
65
66 \membersection{wxStaticLine::Create}\label{wxstaticlinecreate}
67
68 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY},\rtfsp
69 \param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
70 \param{long}{ style = 0}, \param{const wxString\& }{name = ``staticLine"}}
71
72 Creates the static line for two-step construction. See \helpref{wxStaticLine::wxStaticLine}{wxstaticlinector}\rtfsp
73 for further details.
74
75 \membersection{wxStaticLine::IsVertical}\label{wxstaticlineisvertical}
76
77 \constfunc{bool}{IsVertical}{\void}
78
79 Returns true if the line is vertical, false if horizontal.
80
81 \membersection{wxStaticLine::GetDefaultSize}\label{wxstaticlinegetdefaultsize}
82
83 \func{int}{GetDefaultSize}{\void}
84
85 This static function returns the size which will be given to the smaller
86 dimension of the static line, i.e. its height for a horizontal line or its
87 width for a vertical one.
88