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 \wxheading{Derived from}
  17
  18 \helpref{wxControl}{wxcontrol}\\
  19 \helpref{wxWindow}{wxwindow}\\
  20 \helpref{wxEvtHandler}{wxevthandler}\\
  21 \helpref{wxObject}{wxobject}
  22
  23 \wxheading{Include files}
  24
  25 <wx/collpane.h>
  26
  27 \wxheading{Window styles}
  28
  29 There are no specific styles for this window.
  30
  31 See also \helpref{window styles overview}{windowstyles}.
  32
  33 \wxheading{See also}
  34
  35 \helpref{wxPanel}{wxpanel}
  36
  37 \latexignore{\rtfignore{\wxheading{Members}}}
  38
  39
  40
  41 \membersection{wxCollapsiblePane::wxCollapsiblePane}\label{wxcollapsiblepane}
  42
  43 \func{}{wxCollapsiblePane}{\param{wxWindow *}{parent},\rtfsp
  44 \param{wxWindowID}{ id},\rtfsp
  45 \param{const wxString\& }{label},\rtfsp
  46 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  47 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  48 \param{long}{ style = wxCP\_DEFAULT\_STYLE},\rtfsp
  49 \param{const wxValidator\& }{validator = wxDefaultValidator},
  50 \param{const wxString\& }{name = ``collapsiblePane"}}
  51
  52 Initializes the object and calls \helpref{Create}{wxcollapsiblepanecreate} with
  53 all the parameters.
  54
  55
  56 \membersection{wxCollapsiblePane::Create}\label{wxcollapsiblepanecreate}
  57
  58 \func{bool}{Create}{\param{wxWindow *}{parent},\rtfsp
  59 \param{wxWindowID}{ id},\rtfsp
  60 \param{const wxString\& }{label},\rtfsp
  61 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
  62 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  63 \param{long}{ style = wxCP\_DEFAULT\_STYLE},\rtfsp
  64 \param{const wxValidator\& }{validator = wxDefaultValidator},
  65 \param{const wxString\& }{name = ``colourpickerctrl"}}
  66
  67 \wxheading{Parameters}
  68
  69 \docparam{parent}{Parent window, must not be non-\texttt{NULL}.}
  70
  71 \docparam{id}{The identifier for the control.}
  72
  73 \docparam{label}{The initial label shown in the button which allows the user to expand or collapse the pane window.}
  74
  75 \docparam{pos}{Initial position.}
  76
  77 \docparam{size}{Initial size.}
  78
  79 \docparam{style}{The window style, see {\tt wxCP\_*} flags.}
  80
  81 \docparam{validator}{Validator which can be used for additional date checks.}
  82
  83 \docparam{name}{Control name.}
  84
  85 \wxheading{Return value}
  86
  87 \true if the control was successfully created or \false if creation failed.
  88
  89
  90 \membersection{wxCollapsiblePane::IsCollapsed}\label{wxcollapsiblepaneiscollapsed}
  91
  92 \constfunc{bool}{IsCollapsed}{\void}
  93
  94 Returns \true if the pane window is currently hidden.
  95
  96
  97 \membersection{wxCollapsiblePane::IsExpanded}\label{wxcollapsiblepaneisexpanded}
  98
  99 \constfunc{bool}{IsExpanded}{\void}
 100
 101 Returns \true if the pane window is currently shown.
 102
 103
 104 \membersection{wxCollapsiblePane::Collapse}\label{wxcollapsiblepanecollapse}
 105
 106 \func{void}{Collapse}{\param{bool }{collapse = true}}
 107
 108 Collapses or expands the pane window.
 109
 110
 111 \membersection{wxCollapsiblePane::Expand}\label{wxcollapsiblepaneexpand}
 112
 113 \func{void}{Expand}{\void}
 114
 115 Same as \texttt{\helpref{Collapse}{wxcollapsiblepanecollapse}(false)}.
 116
 117