docs/latex/wx/collpane.tex

   1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   2 %% Name:        collpane.tex
   3 %% Purpose:     wxCollapsiblePane documentation
   4 %% Author:      Francesco Montorsi
   5 %% Created:     2006-10-14
   6 %% RCS-ID:      $Id$
   7 %% Copyright:   (c) 2006 Francesco Montorsi
   8 %% License:     wxWindows license
   9 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  10
  11 \section{\class{wxCollapsiblePane}}\label{wxcollapsiblepane}
  12
  13 A collapsable panel is a container with an embedded button-like control which can be
  14 used by the user to collapse or expand the pane's contents.
  15
  16 Note that because of its nature of control which can dynamically (and drastically)
  17 change its size at run-time under user-input, when putting wxCollapsiblePane inside
  18 a \helpref{wxSizer}{wxsizer} you should be careful to add it with a proportion value
  19 of zero; this is because otherwise all other windows with non-null proportion values
  20 would automatically get resized each time the user expands or collaps the pane window.
  21
  22 It is only available if \texttt{wxUSE\_COLLPANE} is set to $1$ (the default).
  23
  24 \wxheading{Derived from}
  25
  26 \helpref{wxControl}{wxcontrol}\\
  27 \helpref{wxWindow}{wxwindow}\\
  28 \helpref{wxEvtHandler}{wxevthandler}\\
  29 \helpref{wxObject}{wxobject}
  30
  31 \wxheading{Include files}
  32
  33 <wx/collpane.h>
  34
  35 \wxheading{Window styles}
  36
  37 \twocolwidtha{5cm}%
  38 \begin{twocollist}\itemsep=0pt
  39 \twocolitem{\windowstyle{wxCP\_DEFAULT\_STYLE}}{The default style: 0.}
  40 \end{twocollist}
  41
  42 \wxheading{Event handling}
  43
  44 \twocolwidtha{7cm}%
  45 \begin{twocollist}\itemsep=0pt
  46 \twocolitem{{\bf EVT\_COLLAPSIBLEPANE\_CHANGED(id, func)}}{The user showed or hidden the collapsible pane. }
  47 \end{twocollist}
  48
  49
  50 \wxheading{See also}
  51
  52 \helpref{wxPanel}{wxpanel}
  53
  54 \latexignore{\rtfignore{\wxheading{Members}}}
  55
  56
  57
  58 \membersection{wxCollapsiblePane::wxCollapsiblePane}\label{wxcollapsiblepane}
  59
  60 \func{}{wxCollapsiblePane}{\param{wxWindow *}{parent},\rtfsp
  61 \param{wxWindowID}{ id},\rtfsp
  62 \param{const wxString\& }{label},\rtfsp
  63 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  64 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  65 \param{long}{ style = wxCP\_DEFAULT\_STYLE},\rtfsp
  66 \param{const wxValidator\& }{validator = wxDefaultValidator},
  67 \param{const wxString\& }{name = ``collapsiblePane"}}
  68
  69 Initializes the object and calls \helpref{Create}{wxcollapsiblepanecreate} with
  70 all the parameters.
  71
  72
  73 \membersection{wxCollapsiblePane::Create}\label{wxcollapsiblepanecreate}
  74
  75 \func{bool}{Create}{\param{wxWindow *}{parent},\rtfsp
  76 \param{wxWindowID}{ id},\rtfsp
  77 \param{const wxString\& }{label},\rtfsp
  78 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  79 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  80 \param{long}{ style = wxCP\_DEFAULT\_STYLE},\rtfsp
  81 \param{const wxValidator\& }{validator = wxDefaultValidator},
  82 \param{const wxString\& }{name = ``colourpickerctrl"}}
  83
  84 \wxheading{Parameters}
  85
  86 \docparam{parent}{Parent window, must not be non-\texttt{NULL}.}
  87
  88 \docparam{id}{The identifier for the control.}
  89
  90 \docparam{label}{The initial label shown in the button which allows the user to expand or collapse the pane window.}
  91
  92 \docparam{pos}{Initial position.}
  93
  94 \docparam{size}{Initial size.}
  95
  96 \docparam{style}{The window style, see {\tt wxCP\_*} flags.}
  97
  98 \docparam{validator}{Validator which can be used for additional date checks.}
  99
 100 \docparam{name}{Control name.}
 101
 102 \wxheading{Return value}
 103
 104 \true if the control was successfully created or \false if creation failed.
 105
 106
 107 \membersection{wxCollapsiblePane::IsCollapsed}\label{wxcollapsiblepaneiscollapsed}
 108
 109 \constfunc{bool}{IsCollapsed}{\void}
 110
 111 Returns \true if the pane window is currently hidden.
 112
 113
 114 \membersection{wxCollapsiblePane::IsExpanded}\label{wxcollapsiblepaneisexpanded}
 115
 116 \constfunc{bool}{IsExpanded}{\void}
 117
 118 Returns \true if the pane window is currently shown.
 119
 120
 121 \membersection{wxCollapsiblePane::Collapse}\label{wxcollapsiblepanecollapse}
 122
 123 \func{void}{Collapse}{\param{bool }{collapse = true}}
 124
 125 Collapses or expands the pane window.
 126
 127
 128 \membersection{wxCollapsiblePane::Expand}\label{wxcollapsiblepaneexpand}
 129
 130 \func{void}{Expand}{\void}
 131
 132 Same as \texttt{\helpref{Collapse}{wxcollapsiblepanecollapse}(false)}.
 133
 134