oracular (3) ControlInfo.3U.gz

NAME

       ControlInfo - object for storing control-related information

SYNOPSIS

       #include <Unidraw/ctrlinfo.h>

DESCRIPTION

       A ControlInfo object stores information from which to build a Control for executing a command or engaging
       the current tool. The ControlInfo object is stored with the command  or  tool,  thus  providing  all  the
       information necessary to recreate the interface when the command or tool is retrieved from disk through a
       catalog. The ControlInfo object also defines the mapping between a keycode and  a  UControl  instance  to
       support keyboard equivalents via the KeyMap class.

PUBLIC OPERATIONS

       ControlInfo(
           GraphicComp* label, const char* keylabel = ``'',
           const char* keycode = ``'', void* owner = nil
       )

       ControlInfo(
           const char* label , const char* = ``'',
           const char* = ``'', void* = nil
       )
              Create  a new ControlInfo instance, supplying either a GraphicComp or a character string to define
              its label's appearance.  The label parameter is an iconic or textual cue that a  control  displays
              to  identify  the  command  or tool it activates.  The keylabel parameter specifies a string to be
              displayed in the control that identifies the control's  keyboard  equivalent,  while  the  keycode
              parameter  defines  the  mapping between a keyboard event and the ControlInfo.  Finally, the owner
              parameter specifies the command or tool instance to which the ControlInfo object corresponds.

       void SetLabel(GraphicComp*)
       void SetLabel(const char*)
       void SetKeyLabel(const char*)
       void SetKeyCode(const char*)
       void SetOwner(void*)

       GraphicComp* GetLabel()
       const char* GetKeyLabel()
       const char* GetKeyCode()
       void* GetOwner()
              Explicitly set or get a constructor-specified parameter.  The Set operations delete the value they
              replace if it is different from the given one. The string setting operations copy their arguments.

       virtual ControlInfo* Copy()
              Return a copy of this ControlInfo object, copying its constituent members.

SEE ALSO

       Catalog(3U), Command(3U), KeyMap(3U), Tool(3U), UControl(3U), uctrls(3U)