sections cleanup

[wxWidgets.git] / docs / latex / wx / paneinfo.tex

\section{\class{wxAuiPaneInfo}}\label{wxauipaneinfo}

wxAuiPaneInfo is part of the wxAUI class framework.
See also \helpref{wxAUI overview}{wxauioverview}.

wxAuiPaneInfo specifies all the parameters for a pane.
These parameters specify where the pane is on the
screen, whether it is docked or floating, or hidden.
In addition, these parameters specify the pane's
docked position, floating position, preferred size,
minimum size, caption text among many other parameters.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<wx/aui/aui.h>

\wxheading{See also}

\helpref{wxAuiManager}{wxauimanager}

\wxheading{Data structures}

\begin{verbatim}
enum wxPaneDockArtSetting
{
    wxAUI_ART_SASH_SIZE = 0,
    wxAUI_ART_CAPTION_SIZE = 1,
    wxAUI_ART_GRIPPER_SIZE = 2,
    wxAUI_ART_PANE_BORDER_SIZE = 3,
    wxAUI_ART_PANE_BUTTON_SIZE = 4,
    wxAUI_ART_BACKGROUND_COLOUR = 5,
    wxAUI_ART_SASH_COLOUR = 6,
    wxAUI_ART_ACTIVE_CAPTION_COLOUR = 7,
    wxAUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR = 8,
    wxAUI_ART_INACTIVE_CAPTION_COLOUR = 9,
    wxAUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR = 10,
    wxAUI_ART_ACTIVE_CAPTION_TEXT_COLOUR = 11,
    wxAUI_ART_INACTIVE_CAPTION_TEXT_COLOUR = 12,
    wxAUI_ART_BORDER_COLOUR = 13,
    wxAUI_ART_GRIPPER_COLOUR = 14,
    wxAUI_ART_CAPTION_FONT = 15,
    wxAUI_ART_GRADIENT_TYPE = 16
}
\end{verbatim}

\begin{verbatim}
enum wxPaneDockArtGradients
{
    wxAUI_GRADIENT_NONE = 0,
    wxAUI_GRADIENT_VERTICAL = 1,
    wxAUI_GRADIENT_HORIZONTAL = 2
}
\end{verbatim}

\begin{verbatim}
enum wxPaneButtonState
{
    wxAUI_BUTTON_STATE_NORMAL = 0,
    wxAUI_BUTTON_STATE_HOVER = 1,
    wxAUI_BUTTON_STATE_PRESSED = 2
}
\end{verbatim}

\begin{verbatim}
enum wxPaneInsertLevel
{
    wxAUI_INSERT_PANE = 0,
    wxAUI_INSERT_ROW = 1,
    wxAUI_INSERT_DOCK = 2
}
\end{verbatim}

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


\membersection{wxAuiPaneInfo::wxAuiPaneInfo}\label{wxauipaneinfowxauipaneinfo}

\func{}{wxAuiPaneInfo}{\void}


\func{}{wxAuiPaneInfo}{\param{const wxAuiPaneInfo\& }{c}}


\membersection{wxAuiPaneInfo::\destruct{wxAuiPaneInfo}}\label{wxauipaneinfodtor}

\func{}{\destruct{wxAuiPaneInfo}}{\void}


\membersection{wxAuiPaneInfo::BestSize}\label{wxauipaneinfobestsize}

\func{wxAuiPaneInfo\&}{BestSize}{\param{const wxSize\& }{size}}


\func{wxAuiPaneInfo\&}{BestSize}{\param{int }{x}, \param{int }{y}}


\membersection{wxAuiPaneInfo::Bottom}\label{wxauipaneinfobottom}

\func{wxAuiPaneInfo\&}{Bottom}{\void}


\membersection{wxAuiPaneInfo::BottomDockable}\label{wxauipaneinfobottomdockable}

\func{wxAuiPaneInfo\&}{BottomDockable}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::Caption}\label{wxauipaneinfocaption}

\func{wxAuiPaneInfo\&}{Caption}{\param{const wxString\& }{c}}


\membersection{wxAuiPaneInfo::CaptionVisible}\label{wxauipaneinfocaptionvisible}

\func{wxAuiPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}}


\membersection{wxAuiPaneInfo::Center}\label{wxauipaneinfocenter}

\func{wxAuiPaneInfo\&}{Center}{\void}


\membersection{wxAuiPaneInfo::CenterPane}\label{wxauipaneinfocenterpane}

\func{wxAuiPaneInfo\&}{CenterPane}{\void}


\membersection{wxAuiPaneInfo::Centre}\label{wxauipaneinfocentre}

\func{wxAuiPaneInfo\&}{Centre}{\void}


\membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane}

\func{wxAuiPaneInfo\&}{CentrePane}{\void}


\membersection{wxAuiPaneInfo::CloseButton}\label{wxauipaneinfoclosebutton}

\func{wxAuiPaneInfo\&}{CloseButton}{\param{bool }{visible = true}}


\membersection{wxAuiPaneInfo::DefaultPane}\label{wxauipaneinfodefaultpane}

\func{wxAuiPaneInfo\&}{DefaultPane}{\void}


\membersection{wxAuiPaneInfo::DestroyOnClose}\label{wxauipaneinfodestroyonclose}

\func{wxAuiPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::Direction}\label{wxauipaneinfodirection}

\func{wxAuiPaneInfo\&}{Direction}{\param{int }{direction}}


\membersection{wxAuiPaneInfo::Dock}\label{wxauipaneinfodock}

\func{wxAuiPaneInfo\&}{Dock}{\void}


\membersection{wxAuiPaneInfo::Dockable}\label{wxauipaneinfodockable}

\func{wxAuiPaneInfo\&}{Dockable}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::Fixed}\label{wxauipaneinfofixed}

\func{wxAuiPaneInfo\&}{Fixed}{\void}


\membersection{wxAuiPaneInfo::Float}\label{wxauipaneinfofloat}

\func{wxAuiPaneInfo\&}{Float}{\void}


\membersection{wxAuiPaneInfo::Floatable}\label{wxauipaneinfofloatable}

\func{wxAuiPaneInfo\&}{Floatable}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::FloatingPosition}\label{wxauipaneinfofloatingposition}

\func{wxAuiPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}}


\func{wxAuiPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}}


\membersection{wxAuiPaneInfo::FloatingSize}\label{wxauipaneinfofloatingsize}

\func{wxAuiPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}}


\func{wxAuiPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}}


\membersection{wxAuiPaneInfo::Gripper}\label{wxauipaneinfogripper}

\func{wxAuiPaneInfo\&}{Gripper}{\param{bool }{visible = true}}


\membersection{wxAuiPaneInfo::GripperTop}\label{wxauipaneinfogrippertop}

\func{wxAuiPaneInfo\&}{GripperTop}{\param{bool }{attop = true}}


\membersection{wxAuiPaneInfo::HasBorder}\label{wxauipaneinfohasborder}

\constfunc{bool}{HasBorder}{\void}


\membersection{wxAuiPaneInfo::HasCaption}\label{wxauipaneinfohascaption}

\constfunc{bool}{HasCaption}{\void}


\membersection{wxAuiPaneInfo::HasCloseButton}\label{wxauipaneinfohasclosebutton}

\constfunc{bool}{HasCloseButton}{\void}


\membersection{wxAuiPaneInfo::HasFlag}\label{wxauipaneinfohasflag}

\constfunc{bool}{HasFlag}{\param{unsigned int }{flag}}


\membersection{wxAuiPaneInfo::HasGripper}\label{wxauipaneinfohasgripper}

\constfunc{bool}{HasGripper}{\void}


\membersection{wxAuiPaneInfo::HasGripperTop}\label{wxauipaneinfohasgrippertop}

\constfunc{bool}{HasGripperTop}{\void}


\membersection{wxAuiPaneInfo::HasMaximizeButton}\label{wxauipaneinfohasmaximizebutton}

\constfunc{bool}{HasMaximizeButton}{\void}


\membersection{wxAuiPaneInfo::HasMinimizeButton}\label{wxauipaneinfohasminimizebutton}

\constfunc{bool}{HasMinimizeButton}{\void}


\membersection{wxAuiPaneInfo::HasPinButton}\label{wxauipaneinfohaspinbutton}

\constfunc{bool}{HasPinButton}{\void}


\membersection{wxAuiPaneInfo::Hide}\label{wxauipaneinfohide}

\func{wxAuiPaneInfo\&}{Hide}{\void}


\membersection{wxAuiPaneInfo::IsBottomDockable}\label{wxauipaneinfoisbottomdockable}

\constfunc{bool}{IsBottomDockable}{\void}


\membersection{wxAuiPaneInfo::IsDocked}\label{wxauipaneinfoisdocked}

\constfunc{bool}{IsDocked}{\void}


\membersection{wxAuiPaneInfo::IsFixed}\label{wxauipaneinfoisfixed}

\constfunc{bool}{IsFixed}{\void}


\membersection{wxAuiPaneInfo::IsFloatable}\label{wxauipaneinfoisfloatable}

\constfunc{bool}{IsFloatable}{\void}


\membersection{wxAuiPaneInfo::IsFloating}\label{wxauipaneinfoisfloating}

\constfunc{bool}{IsFloating}{\void}


\membersection{wxAuiPaneInfo::IsLeftDockable}\label{wxauipaneinfoisleftdockable}

\constfunc{bool}{IsLeftDockable}{\void}


\membersection{wxAuiPaneInfo::IsMovable}\label{wxauipaneinfoismovable}

\constfunc{bool}{IsMovable}{\void}


\membersection{wxAuiPaneInfo::IsOk}\label{wxauipaneinfoisok}

\constfunc{bool}{IsOk}{\void}


\membersection{wxAuiPaneInfo::IsResizable}\label{wxauipaneinfoisresizable}

\constfunc{bool}{IsResizable}{\void}


\membersection{wxAuiPaneInfo::IsRightDockable}\label{wxauipaneinfoisrightdockable}

\constfunc{bool}{IsRightDockable}{\void}


\membersection{wxAuiPaneInfo::IsShown}\label{wxauipaneinfoisshown}

\constfunc{bool}{IsShown}{\void}


\membersection{wxAuiPaneInfo::IsToolbar}\label{wxauipaneinfoistoolbar}

\constfunc{bool}{IsToolbar}{\void}


\membersection{wxAuiPaneInfo::IsTopDockable}\label{wxauipaneinfoistopdockable}

\constfunc{bool}{IsTopDockable}{\void}


\membersection{wxAuiPaneInfo::Layer}\label{wxauipaneinfolayer}

\func{wxAuiPaneInfo\&}{Layer}{\param{int }{layer}}


\membersection{wxAuiPaneInfo::Left}\label{wxauipaneinfoleft}

\func{wxAuiPaneInfo\&}{Left}{\void}


\membersection{wxAuiPaneInfo::LeftDockable}\label{wxauipaneinfoleftdockable}

\func{wxAuiPaneInfo\&}{LeftDockable}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::MaxSize}\label{wxauipaneinfomaxsize}

\func{wxAuiPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}}


\func{wxAuiPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}}


\membersection{wxAuiPaneInfo::MaximizeButton}\label{wxauipaneinfomaximizebutton}

\func{wxAuiPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}}


\membersection{wxAuiPaneInfo::MinSize}\label{wxauipaneinfominsize}

\func{wxAuiPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}}


\func{wxAuiPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}}


\membersection{wxAuiPaneInfo::MinimizeButton}\label{wxauipaneinfominimizebutton}

\func{wxAuiPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}}


\membersection{wxAuiPaneInfo::Movable}\label{wxauipaneinfomovable}

\func{wxAuiPaneInfo\&}{Movable}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::Name}\label{wxauipaneinfoname}

\func{wxAuiPaneInfo\&}{Name}{\param{const wxString\& }{n}}


\membersection{wxAuiPaneInfo::PaneBorder}\label{wxauipaneinfopaneborder}

\func{wxAuiPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}}


\membersection{wxAuiPaneInfo::PinButton}\label{wxauipaneinfopinbutton}

\func{wxAuiPaneInfo\&}{PinButton}{\param{bool }{visible = true}}


\membersection{wxAuiPaneInfo::Position}\label{wxauipaneinfoposition}

\func{wxAuiPaneInfo\&}{Position}{\param{int }{pos}}


\membersection{wxAuiPaneInfo::Resizable}\label{wxauipaneinforesizable}

\func{wxAuiPaneInfo\&}{Resizable}{\param{bool }{resizable = true}}


\membersection{wxAuiPaneInfo::Right}\label{wxauipaneinforight}

\func{wxAuiPaneInfo\&}{Right}{\void}


\membersection{wxAuiPaneInfo::RightDockable}\label{wxauipaneinforightdockable}

\func{wxAuiPaneInfo\&}{RightDockable}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::Row}\label{wxauipaneinforow}

\func{wxAuiPaneInfo\&}{Row}{\param{int }{row}}


\membersection{wxAuiPaneInfo::SafeSet}\label{wxauipaneinfosafeset}

\func{void}{SafeSet}{\param{wxAuiPaneInfo }{source}}

Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
used on loading perspectives etc.


\membersection{wxAuiPaneInfo::SetFlag}\label{wxauipaneinfosetflag}

\func{wxAuiPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}}


\membersection{wxAuiPaneInfo::Show}\label{wxauipaneinfoshow}

\func{wxAuiPaneInfo\&}{Show}{\param{bool }{show = true}}


\membersection{wxAuiPaneInfo::ToolbarPane}\label{wxauipaneinfotoolbarpane}

\func{wxAuiPaneInfo\&}{ToolbarPane}{\void}


\membersection{wxAuiPaneInfo::Top}\label{wxauipaneinfotop}

\func{wxAuiPaneInfo\&}{Top}{\void}


\membersection{wxAuiPaneInfo::TopDockable}\label{wxauipaneinfotopdockable}

\func{wxAuiPaneInfo\&}{TopDockable}{\param{bool }{b = true}}


\membersection{wxAuiPaneInfo::Window}\label{wxauipaneinfowindow}

\func{wxAuiPaneInfo\&}{Window}{\param{wxWindow* }{w}}


\membersection{wxAuiPaneInfo::operator=}\label{wxauipaneinfooperatorassign}

\func{wxAuiPaneInfo\& operator}{operator=}{\param{const wxAuiPaneInfo\& }{c}}