You may return to the Cvo Object Documenation Index from this document. This document contains the following sections describing the Cvo_MenuLabel object:

Class

Cvo_MenuLabel

Base

Cvo_Window

Overview

The Cvo_MenuLabel object is used to display an entry in a menu, such as the Cvo_Menu object. It is created by each object as needed, and therefore it should never need to be explicitly created. The Cvo_MenuLabel object can provide a small toggle button to the left when required. It can also provide an arrow to the right, for a cascade menu, when required.

The label text provided for this object, whether in a resource, or via the SetText() or SetDefaultText() member functions, will be parsed for a quick key and an accelerator.

A quick key is a key which can cause this label to be selected immediately, when the menu is displayed. It is designated with an underbar before it. Quick keys should be unique on menus. Quick keys are not case sensitive.

An accelerator is a combination of keystrokes which can cause this label to selected, and its associated action taken, whether or not the menu it is on has been displayed. The accelerator is designated by a trailing portion of the label text, preceded by a plus (+) character. Accelerators should be unique in an application. The rules for an accelerator are documented with the Cvo_Accelerator object.

For instance, the label text "_Toggle + <CTRL-T>" will cause the Cvo_MenuLabel object to display "Toggle" as the label text. The "T" key, when pressed, will cause this menu item to be selected. If the "Control-T" key combination is pressed, regardless of whether or not the menu is displayed, then this menu item will be selected.

Member Functions

This object defines the following member functions in addition to those defined by its parent and ancestor objects.

Cvo Events

This object defines the following Cvo Events in addition to those defined by its parent and ancestor objects.

New X Resources

This object uses the following X resources in addition to those used by its parent and ancestor objects.

Modified X Resources

This object modifies the following X resources which are used by its parent or other ancestors.


See the example source code for an example of how to use this object.


See the legend for information about the conventions used in this documentation.