Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 1.52 KB

GuiPaneControl.rst

File metadata and controls

54 lines (32 loc) · 1.52 KB
Raw

GuiPaneControl

A collapsable pane control.

Inherit:
:doc:`GuiControl`

Description

This class wraps a single child control and displays a header with caption above it. If you click the header it will collapse or expand (if collapsable is enabled). The control resizes itself based on its collapsed/expanded size. In the GUI editor, if you just want the header you can make collapsable false. The caption field lets you set the caption; it expects a bitmap (from the GuiControlProfile) that contains two images - the first is displayed when the control is expanded and the second is displayed when it is collapsed. The header is sized based on the first image.

Example:

newGuiPaneControl()
{
   caption = "Example Pane";
   collapsable = "1";
   barBehindText = "1";
   //Properties not specific to this control have been omitted from this example.
};

Methods

.. cpp:function:: void GuiPaneControl::setCollapsed(bool collapse)

        Collapse or un-collapse the control.

        :param collapse: True to collapse the control, false to un-collapse it

Fields

.. cpp:member:: bool  GuiPaneControl::barBehindText

        Whether to draw the bitmapped pane bar behind the header text, too.


.. cpp:member:: string  GuiPaneControl::caption

        Text label to display as the pane header.


.. cpp:member:: string  GuiPaneControl::captionID

        String table text ID to use as caption string (overrides 'caption').


.. cpp:member:: bool  GuiPaneControl::collapsable

        Whether the pane can be collapsed by clicking its header.