wxWidgets/docs/latex/wx/statline.tex

\section{\class{wxStaticLine}}\label{wxstaticline}

A static line is just a line which may be used in a dialog to separate the
groups of controls. The line may be only vertical or horizontal.

\wxheading{Derived from}

\helpref{wxControl}{wxcontrol}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/statline.h>

\wxheading{Window styles}

\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{\windowstyle{wxLI\_HORIZONTAL}}{Creates a horizontal line.}
\twocolitem{\windowstyle{wxLI\_VERTICAL}}{Creates a vertical line.}
\end{twocollist}

\wxheading{See also}

\helpref{wxStaticBox}{wxstaticbox}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxStaticLine::wxStaticLine}\label{wxstaticlinector}

\func{}{wxStaticLine}{\void}

Default constructor.

\func{}{wxStaticLine}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = wxLI\_HORIZONTAL}, \param{const wxString\& }{name = ``staticLine"}}

Constructor, creating and showing a static line.

\wxheading{Parameters}

\docparam{parent}{Parent window. Must not be NULL.}

\docparam{id}{Window identifier. A value of -1 indicates a default value.}

\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}

\docparam{size}{Size. Note that either the height or the width (depending on
whether the line if horizontal or vertical) is ignored.}

\docparam{style}{Window style (either wxLI\_HORIZONTAL or wxLI\_VERTICAL).}

\docparam{name}{Window name.}

\wxheading{See also}

\helpref{wxStaticLine::Create}{wxstaticlinecreate}

\membersection{wxStaticLine::Create}\label{wxstaticlinecreate}

\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
\param{const wxPoint\&}{ pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticLine"}}

Creates the static line for two-step construction. See \helpref{wxStaticLine::wxStaticLine}{wxstaticlinector}\rtfsp
for further details.

\membersection{wxStaticLine::IsVertical}\label{wxstaticlineisvertical}

\constfunc{bool}{IsVertical}{\void}

Returns TRUE if the line is vertical, FALSE if horizontal.

\membersection{wxStaticLine::GetDefaultSize}\label{wxstaticlinegetdefaultsize}

\func{int}{GetDefaultSize}{\void}

This static function returns the size which will be given to the smaller
dimension of the static line, i.e. its height for a horizontal line or its
width for a vertical one.