VkMenuToggle(3x)

NAME
     VkMenuToggle - Class that support two-state actions in menus

INHERITS FROM
     VkMenuAction : VkMenuItem : VkComponent : VkCallbackObject

HEADER FILE
     #include <Vk/VkMenuItem.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkMenuToggle(const char *, XtCallbackProc, XtPointer);
           VkMenuToggle(const char *, XtCallbackProc,
                        XtCallbackProc, XtPointer);
           ~VkMenuToggle();


   Manipulating Menu Items
           void setVisualState(Boolean state);
           void setStateAndNotify(Boolean);


   Access Functions
           virtual const char* className();
           virtual VkMenuItemType menuType ();
           Boolean getState();


CLASS DESCRIPTION
     The VkMenuToggle class represents a user-selectable two-state button in a
     menu.  Objects of type VkMenuToggle can be placed in any VkMenu subclass.
     The VkMenuToggle adds an XmToggleButton gadget into its parent menu pane.
     Like all VkMenuItems, VkMenuToggle objects can be activated, deactivated,
     replaced, and so on.

     If an action has an undo callback, the object automatically registers
     itself with an instance of the VkUndoManager class when the action is
     executed. An undo callback can be specified when the object is
     instantiated.

FUNCTION DESCRIPTIONS
   VkMenuToggle
           VkMenuToggle(const char *, XtCallbackProc, XtPointer);
           VkMenuToggle(const char *, XtCallbackProc,
                        XtCallbackProc, XtPointer);


          Construct a VkMenuAction object. No widgets are built in the
          constructor.
   ~VkMenuToggle
           ~VkMenuToggle();


          Clean up on destruction of a VkMenuToggle object.

   className
           virtual const char* className();


          Returns "VkMenuToggle".

   menuType
           virtual VkMenuItemType menuType ();

     Returns VkMenuItem::TOGGLE

   setVisualState
           void setVisualState(Boolean state);


          If state is TRUE, this function "sets" the toggle button. If FALSE,
          this function unsets the button. No callbacks are invoked.

   setStateAndNotify
           void setStateAndNotify(Boolean state);


          If state is TRUE, this function "sets" the toggle button. If FALSE,
          this function unsets the button. Any callbacks associated with this
          item are called when the state changes.


   getState
           Boolean getState();


          Return the current value of the VkMenuToggle item.

INHERITED MEMBER FUNCTIONS
   Inherited from VkMenuAction
          undo(),  hasUndo(),  _undoCallback _func,  _data,


   Inherited from VkMenuItem
          show(), hide(), manageAll(), setLabel(), setPosition(), activate(),
          deactivate(), remove(), show(), isContainer(), _position, _isBuilt,
          _sensitive, _parentMenu, _label, _isHidden, _unmanagedWidgets,
          _numUnmanagedWidgets,
   Inherited from VkComponent
          installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
          setDefaultResources(), getResources(), manage(), unmanage(),
          baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback


   Inherited from VkCallbackObject
          callCallbacks(), addCallback(), removeCallback(),
          removeAllCallbacks()


KNOWN CLASSES THAT USE THIS CLASS
     VkMenu, VkMenuToggle

SEE ALSO
     VkMenuAction, VkMenuItem, VkComponent, VkMenu
     ViewKit Programmer's Guide
     The X Window System, DEC Press, Bob Sheifler and Jim Gettys
     The X Window System Toolkit, DEC Press, Paul Asente and Ralph Swick
     The OSF/Motif Programmers Reference, Prentice Hall, OSF