VkTickMarks(3x)

NAME
     VkTickMarks - A component for displaying a vertical set of tick marks

INHERITS FROM
     VkComponent : VkCallbackObject

HEADER FILE
     #include <Vk/VkTickMarks.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkTickMarks(char* name, Widget parent,
                      Boolean labelsToLeft = True,
                      Boolean noLabels = False,
                      Boolean centerLabels = False);
           virtual void ~VkTickMarks(void);


   Configuration
           void setScale(int min, int max,
                          int majorInterval,
                          int minorInterval);


           void setMargin(int marginTop, int marginBottom);


           int labelSpacing(void);


           void addLabel(int value);


X RESOURCES ASSOCIATED WITH THIS CLASS
           minimum             Initial minimum label (0)

           maximum             Initial maximum label (10)

           majorInterval       Major tick interval (5)

           minorInterval       Minor tick interval (1)

           majorSize           Major tick mark width (10 pixels)

           minorSize           Minor tick mark width (6 pixels)

           labelSpacing        Spacing between tick mark and label (3 pixels)

           marginTop           Distance between top of component and tick mark (19 pixels)

           marginBottom        Distance between bottom of component and tick mark (19 pix)

           lineThickness       Tick mark thickness (1 pixel)

           connectTicks            Draw a vertical line connecting the tick marks (False)

           signedLabels            Prefix positive value labels with "+" (False)

           label.foreground    Foreground color used for labels and tick marks

           label.background    Background color used for labels and tick marks

           label.fontList      Font used for labels


CLASS DESCRIPTION
          VkTickMarks presents a vertical set of tick marks.  It is most
          commonly used next to a vertical XmScale widget.  The tick marks can
          be right-justified and the labels to the left (the default), or
          left-justified and the labels to the right.  The former is used when
          the component is to the left of the scale, and the latter when the
          component is to the right.



FUNCTION DESCRIPTIONS
   VkTickMarks()
           VkTickMarks(char* name, Widget parent,
                      Boolean labelsToLeft = True,
                      Boolean noLabels = False,
                      Boolean centerLabels = False);
           virtual void ~VkTickMarks(void);


          VkTickMarks creates a component using the name and parent
          parameters.  The optional labelsToLeft argument can be used when the
          component is placed to the right of an XmScale widget.  If you set
          labelsToLeft to False, the tick marks will be left-justified and the
          labels drawn to the right of the tick marks.  If you set noLabels to
          True, no labels will be displayed.  If you set centerLabels to True,
          labels will be centered in the area between the edge of the
          component and the tick marks, rather than aligned against the tick
          marks.

   setScale()
           void setScale(int min, int max,
                         int majorInterval,
                         int minorInterval);


          This function changes the configuration parameters of the component.
          Min and max change the minimum and maximum values and labels,
          majorInterval and minorInterval change the tick mark spacing.  The
          initial parameters are set using resources, so applications with
          fixed tick marks need not use this method.

   setMargin()
          void setMargin(int marginTop, int marginBottom);


          This function specified the spacing between the top of the component
          and the first tick mark, and the bottom of the component and the
          last tick mark.  The default setting is controlled using resources,
          and is suitable for placement next to an XmScale widget.  This
          default positions the first and last tick mark so that they
          horizontally line up with the mark in the scale's thumb.

   labelSpacing()
          int labelSpacing(void);


          This function returns the spacing, in pixels, between the tick marks
          and their labels.  This can be useful when placing two VkTickMarks
          components side-by-side, with only one set of labels.  By querying
          this function and using the value as an offset, you can center the
          labels between the two sets of tick marks.

   addLabel()
          void addLabel(int value);


          This function adds another label for a specific value.  By default,
          labels are displayed for the minimum and maximum values.  Calling
          this function will add additional labels to the component.

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


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


BUGS
SEE ALSO
     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