This version of this document is no longer maintained. For the latest documentation, see http://www.qnx.com/developers/docs.

PtMenuButton

A button used to display a menu

Class hierarchy:

PtWidget --> PtBasic --> PtContainer --> PtCompound --> PtMenuButton

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

PhAB icon:

Public header:

<photon/PtMenuButton.h>

Description:

The PtMenuButton class displays text or images with optional accelerator key text. Menu buttons are used to present menus from within menu bars or other menus.

A PtMenuButton widget.

If you want an accelerator key, set the Pt_ARG_ACCEL_KEY resource that's inherited from PtLabel. For example:

narg = 0;
PtSetArg (&args [narg++], Pt_ARG_TEXT_STRING, "File", 0);
PtSetArg (&args [narg++], Pt_ARG_ACCEL_KEY, "F", 0);
PtCreateWidget (PtMenuButton, database.menu, narg, args);

New resources:

These resources are actually defined in <photon/PtMenuLabel.h> for the PtMenuLabel widget, which you'll never instantiate on its own.

Pt_ARG_ACCEL_FONT

The font used to render the hotkey accelerator text.

Pt_ARG_ACCEL_TEXT

The text that identifies the hotkey that's bound to this widget.

Pt_ARG_BUTTON_TYPE

The type of menu button; one of the following:

Pt_MENU_TEXT

Display the accelerator text, if it's defined.

Pt_MENU_RIGHT

Display the submenu to the right of the button.

Pt_MENU_DOWN

Display the submenu below the button.

Pt_MENU_UP

Display the submenu above the button.

Pt_ARG_MODIFIER_KEYS

The modifier key(s) to be displayed in the menu button, expressed as a bitwise OR of one or more of the Pk_KM_* flags defined in <photon/PkKeyDef.h>.

Pt_ARG_OFFSET

The x offset used to render the accelerator text.

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.