VkPrefToggle(3x)

NAME
     VkPrefToggle - Toggle interface for preference package

INHERITS FROM
     VkPrefItem : VkComponent : VkCallbackObject

HEADER FILE
     #include <Vk/VkPrefItem.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkPrefToggle(const char* name,
                        Boolean forceLabelFormat = False);
           virtual void ~VkPrefToggle(void);


   Setting and Getting Values
           void setValue(Boolean value);
           Boolean getValue(void);


CLASS DESCRIPTION
          VkPrefToggle is a toggle preference object.  The user can either
          turn the toggle on or off.  See VkPrefItem for more generic
          information about preference objects.



FUNCTION DESCRIPTIONS
   VkPrefToggle()
           VkPrefToggle(const char* name,
                        Boolean forceLabelFormat = False);
           virtual void ~VkPrefToggle(void);


          Creates a Motif XmToggleButton gadget as its base.  A label for the
          object will be created if the second argument is True or if this
          object is within a container with only other VkPrefToggle objects.
          Otherwise, no explicit label is created and the standard Motif
          toggle widget appearance (i.e. label on the right of the toggle) is
          used.

   setValue()
          void setValue(Boolean value);


          Changes the toggle object's current and real value.

   getValue()
          Boolean getValue(void);
          Copies the toggle object's current value to the real value, and
          returns it.

INHERITED MEMBER FUNCTIONS
   Inherited from VkPrefCustom
          updateValue(),  revertValue(),  VkPrefCustom(),  ~VkPrefCustom(),


   Inherited from VkPrefItem
          VkPrefItem(), ~VkPrefItem(), activate(), deleteChildren(),
          labelHeight(), baseHeight(), setLabelHeight(), setBaseHeight(),
          activateCallback(), installDestroyHandlers(), labelWidget(),
          buildLabel(), getHeight(), setHeight(), _labelWidget, _baseName,
          _labelName, _activated, _homogeneous,


   Inherited from VkComponent
          installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
          setDefaultResources(), getResources().  manage(), unmanage(),
          baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback


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


SEE ALSO
     VkPrefItem, VkComponent, VkPrefToggle,
     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