`PtPanelGroup`

A container that manages panels

Class hierarchy:

PtWidget → PtBasic → PtContainer → PtPanelGroup

For more information, see the diagram of the widget hierarchy.

Description:

A PtPanelGroup is a container that manages panels and optionally provides a method for you to switch between them.

PtPanelGroup example

A PtPanelGroup widget as used in PhAB.

PtPanelGroup provides two modes to switch between panels:

Multiple tabs: As shown above, there's one tab per panel — click on a tab to select a panel.
Single tab: When you click on the tab, a popup menu lets you select a panel:

You can make the PtPanelGroup switch automatically between these two selection modes as necessary, depending on the available space — single-tab mode is useful when there isn't much horizontal space. For more information, see Pt_ARG_PG_SELECTION_MODE.

Populating a panel group

You can populate a PtPanelGroup in the following ways, depending on your requirements:

Multiple panels, created at design time
Single panel, repopulated at runtime.

A PtPanelGroup can use only one population method; you can't add some panels at design time and others at runtime. However, you can add an empty container and populate it at runtime when you switch panels.
If you use the single-panel method to populate the PtPanelGroup at runtime, you can't drag and drop the panels, to avoid the complexity of having different (and possibly conflicting) population methods coexisting in the same panel group.

Multiple panels

When you design the UI for your application, you can put container widgets (i.e. descendants of PtContainer) into a PtPanelGroup. PtPanelGroup manages these containers and incorporates them into the selection mechanism (i.e. it assigns tabs to them).

The panel group uses the Pt_ARG_TITLE resource for each container widget for that widget's tab title.

This method gives you complete control over the layout in an application-building environment (for example, PhAB). The drawback to this method is that it requires more memory at runtime, since all of the widgets in all of the panels exist for the lifetime of the PtPanelGroup.

To add panels to a PtPanelGroup in PhAB, select a container widget from the palette and click on the PtPanelGroup. The container is automatically sized to fit the panel group. When you add other panels, click on the top part of the panel group (i.e. above the existing panels and tabs). Use the Module Tree control panel to verify that the panels are where you want them (for more information, see the chapter on PhAB's environment in the Photon Programmer's Guide).

To flip between existing panels in PhAB, select the PtPanelGroup and change Pt_ARG_PG_CURRENT_INDEX to the number of the panel you wish to edit.

Single panel

At runtime, your application's code can clear and repopulate the PtPanelGroup when a new panel is selected. This method might save a significant amount of memory at runtime, but it's less convenient than the first method, since it requires some code to intercept the panel switching and to repopulate the panel group's display.

This method yields slower switches, since your application must clear the panel group's display and then reconstruct it each time you select a different panel. However, you can design the individual panels in PhAB (as picture modules) and then use PtClearWidget() and ApCreateModule() whenever you switch panels.

If you choose this method to populate a PtPanelGroup, use the Pt_ARG_PG_PANEL_TITLES resource to specify number of panels and their titles.

For an example of using this method, see Pt_CB_PG_PANEL_SWITCHING.

Panel margins

PtPanelGroup defines its own margins in addition to the margin width defined by the PtBasic widget class. There are separate left, right, top, and bottom margins, which are specified using these resources:

Pt_ARG_MARGIN_LEFT
Pt_ARG_MARGIN_RIGHT
Pt_ARG_MARGIN_TOP
Pt_ARG_MARGIN_BOTTOM

These margins are cumulative, so that the actual margin of one edge of the widget is the corresponding resource value added to the margin width.

Panel indexes

Panels are indexed from 0 through n - 1, where n is the number of panels managed by the PtPanelGroup. An index value of Pt_PG_INVALID may be interpreted as a “NULL” value.

The panel indexes indicate the order of panels in the PtPanelGroup; they change when panels are added, removed, or reordered.

New resources:

Resource	C type	Pt type	Default
Pt_ARG_MARGIN_BOTTOM	`unsigned short`	Scalar	5
Pt_ARG_MARGIN_LEFT	`unsigned short`	Scalar	5
Pt_ARG_MARGIN_RIGHT	`unsigned short`	Scalar	5
Pt_ARG_MARGIN_TOP	`unsigned short`	Scalar	3
Pt_ARG_PG_CURRENT	`char *`	String	NULL
Pt_ARG_PG_CURRENT_INDEX	`uint16_t`	Scalar	Pt_PG_INVALID
Pt_ARG_PG_FLAGS	`unsigned short`	Flag	`0x0`
Pt_ARG_PG_OVERLAP_THRESHOLD	`unsigned char`	Scalar	128
Pt_ARG_PG_PANEL_TITLES	`char *`, `unsigned short`	Array	NULL
Pt_ARG_PG_SELECTION_MODE	`unsigned char`	Scalar	Pt_PG_AUTO
Pt_CB_PG_PANEL_SWITCHING	`PtCallback_t *`	Link	NULL

Pt_ARG_MARGIN_BOTTOM

C type	Pt type	Default
`unsigned short`	Scalar	5

The amount of space between the bottom of the panel group's canvas and the canvas defined by the basic widget.

Pt_ARG_MARGIN_LEFT

C type	Pt type	Default
`unsigned short`	Scalar	5

The amount of space between the left side of the panel group's canvas and the canvas defined by the basic widget.

Pt_ARG_MARGIN_RIGHT

C type	Pt type	Default
`unsigned short`	Scalar	5

The amount of space between the right side of the panel group's canvas and the canvas defined by the basic widget.

Pt_ARG_MARGIN_TOP

C type	Pt type	Default
`unsigned short`	Scalar	3

The amount of space between the top of the panel group's canvas and the canvas defined by the basic widget.

Pt_ARG_PG_CURRENT

C type	Pt type	Default
`char *`	String	NULL

The name of the currently selected panel.

You can set this resource to switch to another panel. If more than one panel has the same title, the widget switches to the first one it finds with the specified title.

Pt_ARG_PG_CURRENT_INDEX

C type	Pt type	Default
`uint16_t`	Scalar	Pt_PG_INVALID

The index of the currently selected panel, where 0 indicates the first panel. You can set this resource to switch to another panel.

Pt_ARG_PG_FLAGS

C type	Pt type	Default
`unsigned short`	Flag	`0x0`

This resource controls the behavior of the PtPanelGroup. Possible values are:

Pt_PG_DND

Support drag-and-drop operations of container-type widgets.

Panels that are dragged away from the PtPanelGroup are reparented to another container if one is present at the drop site and it also supports drag-and-drop operations. Otherwise a popup window is created at the drop site with a new PtPanelGroup to display the panel.

If the panel group is populated at runtime, drag-and-drop isn't supported and this flag is ignored.

Pt_PG_MULTI_CONTAINER_MODE (read-only)

The was populated with more than one container. You can't set or clear this bit; the widget sets or clears this bit to reflect its state.

Pt_PG_SELECTOR_ALIGN_RIGHT

Align the tab or tabs to the right of the instead of the left. Pt_ARG_MARGIN_WIDTH controls the amount that the selector is inset from the edge.

Pt_PG_SELECTOR_ON_BOTTOM

Place the tab or tabs at the bottom of the instead of at the top.

Pt_PG_TABS_EQUAL_SIZE

Force all tabs to be the same size. If this bit isn't set, tabs occupy as little space as possible to accommodate their displayable data, and changing the size of one tab doesn't affect the sizes of the others.

Pt_PG_USE_PANEL_COLORS

Let each tab specify its own color. This flag works only when the panelgroup has multiple containers; the text and fill color for the tab are retrieved from the Pt_ARG_COLOR and Pt_ARG_FILL_COLOR resources of the corresponding panel.

Pt_ARG_PG_OVERLAP_THRESHOLD

C type	Pt type	Default
`unsigned char`	Scalar	128

The amount by which tabs can overlap before switching to/from single-tab selection mode (providing the selection type is set to Pt_PG_AUTO).

This quantity is specified as an integer between 0 and 255 and represents a fraction of tab width. For example, a value of 0 doesn't let tabs overlap at all, while a value of 128 lets tabs overlap by up to half their width.

If you set this to too large a value, it might be difficult to use the tabs.

Pt_ARG_PG_PANEL_TITLES

C type	Pt type	Default
`char *`, `unsigned short`	Array	NULL

An array of strings that represent the titles for the panels managed by this PtPanelGroup.

If the PtPanelGroup is populated with multiple containers, Pt_ARG_PG_PANEL_TITLES is a read-only resource.

When you get the value of this resource, it gives the titles of the panels and the number of panels, regardless of how the panel group was populated.

Pt_ARG_PG_SELECTION_MODE

C type	Pt type	Default
`unsigned char`	Scalar	Pt_PG_AUTO

This resource indicates the method you'll use to select panels. One of:

Pt_PG_NONE: Don't use an internal selector. When this mode is in use, panels must be selected programmatically (by setting the Pt_ARG_PG_CURRENT or Pt_ARG_PG_CURRENT_INDEX resource).
Pt_PG_AUTO: Display one tab per panel as long as there's enough space, depending on the sizes of the tabs and the Pt_ARG_PG_OVERLAP_THRESHOLD resource. If there isn't enough space, display a single tab that, when selected, provides a popup list of panels.
Pt_PG_SINGLE_TAB: Use single-tab selection mode, regardless of the space available.

Pt_CB_PG_PANEL_SWITCHING

C type	Pt type	Default
`PtCallback_t *`	Link	NULL

A list of PtCallback_t structures that define the callbacks that are invoked when a new panel is selected. This resource lets you clear and repopulate the display container (if necessary), set up resources of existing panels (if applicable), or prevent the switch by returning a value other than Pt_CONTINUE.

If the widget has the Pt_CALLBACKS_ACTIVE bit set in its Pt_ARG_FLAGS resource, these callbacks are also invoked when your application changes Pt_ARG_PG_CURRENT or Pt_ARG_PG_CURRENT_INDEX by calling PtSetResource() or PtSetResources().

Each callback is passed a PtCallbackInfo_t structure that contains at least the following members:

reason

Pt_CB_PG_PANEL_SWITCHING

reason_subtype

Not used.

event

A pointer to a PhEvent_t structure that describes the event that caused the callback to be invoked. If event is NULL, then the callback was invoked because the selection was changed programmatically.

cbdata

A pointer to a PtPanelGroupCallback_t structure that contains at least:

char *old_panel — the title of the panel that was previously selected, or NULL if no panel was previously selected.
char *new_panel — the title of the newly selected panel, or NULL if no panel is being selected.
uint16_t old_panel_index — the index of the panel that was previously selected, or Pt_PG_INVALID if no panel was previously selected
uint16_t new_panel_index — the index of the newly selected panel, or Pt_PG_INVALID if no panel is being selected.

The panel indexes indicate the order of panels in the PtPanelGroup; they change when panels are added, removed, or reordered.

These callbacks should return Pt_CONTINUE to permit the switch to occur. Returning a value other than Pt_CONTINUE prevents the switch from taking place. This is useful if you want to “lock” the PtPanelGroup to the currently selected panel.

For example, to clear and repopulate a PtPanelGroup at runtime in a Pt_CB_PG_PANEL_SWITCHING callback:

int panelswitch_cb( PtWidget_t *widget,
                    ApInfo_t *apinfo,
                    PtCallbackInfo_t *cbinfo)
{
    PtPanelGroupCallback_t *pgcb =
      (PtPanelGroupCallback_t*)(cbinfo->cbdata);

    /* We use some arbitrary user function that returns
       nonzero if switch is ok */

    if(!switch_ok(widget))
        /* Prevent the switch from happening */
        return(Pt_END);

    /* Clear the PtPanelGroup display */

    PtClearWidget(widget);

    /* Here we use the panel indexes rather than titles
       to figure out current panel. This is deterministic,
       provided the Pt_ARG_PG_PANEL_TITLES resource
       isn't changed. */

    switch(pgcb->new_panel_index)
    {
        case 0:

            /* Populate the display.  Note that we provide
               widget (the PtPanelGroup pointer) as the
               parent.  In this case, PtPanelGroup accepts
               the widgets as children. */

            ApCreateModule(ABM_pic_module_0,widget,NULL);
            PtReRealizeWidget( widget );
            break;

        case 1:

            ApCreateModule(ABM_pic_module_1,widget,NULL);
            PtReRealizeWidget( widget );
            break;

        …
    }

    return(Pt_CONTINUE);    /* Let the switch proceed */
}

Inherited resources:

If the widget modifies an inherited resource, the “Default override” column indicates the new value. This modification affects any subclasses of the widget.

Resource	Inherited from	Default override
Pt_ARG_ANCHOR_FLAGS	`PtWidget`
Pt_ARG_ANCHOR_OFFSETS	`PtWidget`
Pt_ARG_AREA	`PtWidget`
Pt_ARG_BANDWIDTH_THRESHOLD	`PtBasic`	Not used by this class.
Pt_ARG_BASIC_FLAGS	`PtBasic`	Pt_ALL_OUTLINES
Pt_ARG_BEVEL_WIDTH	`PtWidget`	1
Pt_ARG_BITMAP_CURSOR	`PtWidget`
Pt_ARG_BEVEL_COLOR	`PtBasic`
Pt_ARG_BEVEL_CONTRAST	`PtBasic`
Pt_ARG_COLOR	`PtBasic`
Pt_ARG_CONTAINER_FLAGS	`PtContainer`
Pt_ARG_CONTRAST	`PtBasic`
Pt_ARG_CURSOR_COLOR	`PtWidget`
Pt_ARG_CURSOR_OVERRIDE	`PtContainer`
Pt_ARG_CURSOR_TYPE	`PtWidget`
Pt_ARG_DARK_BEVEL_COLOR	`PtBasic`
Pt_ARG_DARK_FILL_COLOR	`PtBasic`
Pt_ARG_DATA	`PtWidget`
Pt_ARG_DIM	`PtWidget`
Pt_ARG_EFLAGS	`PtWidget`
Pt_ARG_EXTENT	`PtWidget`
Pt_ARG_FILL_COLOR	`PtBasic`
Pt_ARG_FILL_PATTERN	`PtBasic`
Pt_ARG_FLAGS	`PtWidget`	\|= Pt_HIGHLIGHTED
Pt_ARG_GRID_LAYOUT_DATA	`PtWidget`
Pt_ARG_HEIGHT	`PtWidget`
Pt_ARG_HELP_TOPIC	`PtWidget`
Pt_ARG_HIGHLIGHT_ROUNDNESS	`PtBasic`
Pt_ARG_INLINE_COLOR	`PtBasic`
Pt_ARG_LAYOUT_DATA	`PtWidget`
Pt_ARG_LIGHT_BEVEL_COLOR	`PtBasic`
Pt_ARG_LIGHT_FILL_COLOR	`PtBasic`
Pt_ARG_MARGIN_HEIGHT	`PtBasic`
Pt_ARG_MARGIN_WIDTH	`PtBasic`
Pt_ARG_MAXIMUM_DIM	`PtWidget`
Pt_ARG_MINIMUM_DIM	`PtWidget`
Pt_ARG_OUTLINE_COLOR	`PtBasic`
Pt_ARG_POINTER	`PtWidget`
Pt_ARG_POS	`PtWidget`
Pt_ARG_RESIZE_FLAGS	`PtWidget`
Pt_ARG_ROW_LAYOUT_DATA	`PtWidget`
Pt_ARG_STYLE	`PtBasic`
Pt_ARG_TITLE	`PtContainer`
Pt_ARG_TITLE_FONT	`PtContainer`
Pt_ARG_TRANS_PATTERN	`PtBasic`
Pt_ARG_USER_DATA	`PtWidget`
Pt_ARG_WIDTH	`PtWidget`
Pt_CB_ACTIVATE	`PtBasic`
Pt_CB_ARM	`PtBasic`
Pt_CB_BALLOONS	`PtContainer`
Pt_CB_BLOCKED	`PtWidget`
Pt_CB_CHILD_ADDED_REMOVED	`PtContainer`
Pt_CB_CHILD_GETTING_FOCUS	`PtContainer`
Pt_CB_CHILD_LOSING_FOCUS	`PtContainer`
Pt_CB_DESTROYED	`PtWidget`
Pt_CB_DISARM	`PtBasic`
Pt_CB_DND	`PtWidget`
Pt_CB_FILTER	`PtWidget`
Pt_CB_GOT_FOCUS	`PtBasic`
Pt_CB_HOTKEY	`PtWidget`
Pt_CB_IS_DESTROYED	`PtWidget`
Pt_CB_LOST_FOCUS	`PtBasic`
Pt_CB_MENU	`PtBasic`
Pt_CB_OUTBOUND	`PtWidget`
Pt_CB_RAW	`PtWidget`
Pt_CB_REALIZED	`PtWidget`
Pt_CB_REPEAT	`PtBasic`
Pt_CB_RESIZE	`PtContainer`
Pt_CB_UNREALIZED	`PtWidget`

Convenience functions:

The PtPanelGroup widget defines the following convenience functions:

PtPGCreatePopup(): Create an empty copy of a panel group as a popup window
PtPGFindIndexByPanel(): Get the index for a panel, given a pointer to the panel
PtPGFindIndexByTitle(): Get the index of a panel, given its title
PtPGFindPanelByIndex(): Get a pointer to the panel widget with a given index
PtPGFindPanelByTitle(): Get a pointer to the panel widget with a given title
PtPGFindTitleByIndex(): Get the title of the panel with a given index

PtPanelGroup

`PtPanelGroup`

Class hierarchy:

PhAB icon:

Public header:

Description:

Populating a panel group

Multiple panels

Single panel

Panel margins

Panel indexes

New resources:

Pt_ARG_MARGIN_BOTTOM

Pt_ARG_MARGIN_LEFT

Pt_ARG_MARGIN_RIGHT

Pt_ARG_MARGIN_TOP

Pt_ARG_PG_CURRENT

Pt_ARG_PG_CURRENT_INDEX

Pt_ARG_PG_FLAGS

Pt_ARG_PG_OVERLAP_THRESHOLD

Pt_ARG_PG_PANEL_TITLES

Pt_ARG_PG_SELECTION_MODE

Pt_CB_PG_PANEL_SWITCHING

Inherited resources:

Convenience functions: