VkOptionMenu(3x)

NAME
     VkOptionMenu - An option menu for use with ViewKit menu items

INHERITS FROM
     VkMenu : VkMenuItem : VkComponent : VkCallbackObject

HEADER FILE
     #include <Vk/VkOptionMenu.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkOptionMenu(VkMenuDesc *desc,
                        XtPointer   defaultClientData = NULL);

           VkOptionMenu(const char *name = "optionMenu",
                        VkMenuDesc *desc = NULL,
                        XtPointer   defaultClientData = NULL);

           VkOptionMenu(Widget      parent,
                        VkMenuDesc *desc,
                        XtPointer   defaultClientData = NULL);

           VkOptionMenu(Widget      parent,
                        const char *name = "optionMenu",
                        VkMenuDesc *desc = NULL,
                        XtPointer   defaultClientData = NULL);

           ~VkOptionMenu();


   Building Menus
           virtual void  build()


   Selecting Items
           void set(char* name);
           void set(int index);
           void set(VkMenuItem* item);


   Determining Selected Items
           int getIndex();
           VkMenuItem *getItem();



   Setting sizes
           void forceWidth(int width);

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


CLASS DESCRIPTION
   Deriving Subclasses
   Other Sections
FUNCTION DESCRIPTIONS
   VkOptionMenu
           VkOptionMenu(VkMenuDesc *desc,
                        XtPointer   defaultClientData = NULL);

           VkOptionMenu(const char *name = "optionMenu",
                        VkMenuDesc *desc = NULL,
                       XtPointer   defaultClientData = NULL);

           VkOptionMenu(Widget      parent,
                        VkMenuDesc *desc,
                        XtPointer   defaultClientData = NULL);

           VkOptionMenu(Widget      parent,
                        const char *name = "optionMenu",
                        VkMenuDesc *desc = NULL,
                        XtPointer   defaultClientData = NULL);


          Initialize an option menu.

   ~VkOptionMenu
           ~VkOptionMenu();


          Cleans up any memory allocated by an option menu.

   build
           virtual void  build()




   set
           void set(char*name);
           void set(int index);
           void set(VkMenuItem* item);


          Set the currently visible menu item in an option menu by name, index
          or a pointer to a VkMenuItem.

   Determining Selected Items
           int getIndex();


          Get the index of the currently selected menu item.

   getItem
           VkMenuItem *getItem();


          Get the currently selected VkMenuItem menu item.

   forceWidth
           void forceWidth(int width);


          Force the width of all items in the option menu to a specific size.

   className
           virtual const char* className();


          Returns "VkOptionMenu".

   menuType
            virtual VkMenuItemType menuType ();


          Returns VkMenuItem::OPTION.

EXAMPLES
              _optionMenu = new VkOptionMenu(parent, "optionMenu");
              _optionMenu->addAction("Red",
                                      &SomeClass::sampleCallback,
                                      (XtPointer) this);
              _optionMenu->addAction("Green",
                                      &SomeClass::sampleCallback,
                                      (XtPointer) this);
              _optionMenu->addAction("Blue",
                                      &SomeClass::sampleCallback,
                                      (XtPointer) this);
              _optionMenu->set("Green");


INHERITED MEMBER FUNCTIONS
   Inherited from VkMenu
          isContainer(), addAction(), addActionWidget(),
          addConfirmFirstAction(), addSeparator(), addLabel(), addToggle(),
          add(), addSubmenu(), addRadioSubmenu(), registerSubmenu(),
          findNamedItem(), removeItem(), activateItem(), deactivateItem(),
          replace(), getItemPosition(), operator[](), numItems(), _contents,
          _nItems, _maxItems
   Inherited from VkMenuItem
          show(), hide(), manageAll(), setLabel(), setPosition(), activate(),
          deactivate(), remove(), show(), _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()


CLASSES USED BY THIS CLASS
     VkMenuItem

KNOWN CLASSES THAT USE THIS CLASS
     VkGraph

SEE ALSO
     VkMenu, VkMenuItem, VkComponent
     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