VkVuMeter(3x)

NAME
     VkVuMeter - A component for displaying a segmented meter

INHERITS FROM
     VkComponent : VkCallbackObject

HEADER FILE
     #include <Vk/VkVuMeter.h>

PUBLIC PROTOCOL SUMMARY
   Constructor/Destructor
           VkVuMeter(char* name, Widget parent);
           virtual void ~VkVuMeter(void);


   Configuration
           void setValue(int value, int peak);


X RESOURCES ASSOCIATED WITH THIS CLASS
           red          Color for highest segments (red)

           yellow            Color for middle segments (yellow)

           green             Color for lowest segments (green)

           sideThickness     Thickness of the side bars (1 pixel)

           sideSpacing       Distance between the side bar and the segment (0 pixels)

           drawSides         Draw the side bars (true)

           granularity       Scale used for spacing and size resources (11)

           spacing           Vertical scaled spacing between segments (1)

           size              Vertical scaled size of segments (9)`[072q

           numReds           Number of highest segments (1)

           numYellows        Number of middle segments (3)

           numGreens         Number of lowest segments (7)

           peakBlock         Draw the peak value as an entire block (False)

           peakHeight        Scaled Height of the peak value line (1)
CLASS DESCRIPTION
          VkVuMeter presents a vertical set of segments as a meter display,
          similar to that used by hi-fi audio displays.  Its value ranges from
          0 to 110, with 0 showing the most segments and 110 showing the
          least.  A peak value is displayed separately, as an entire block or
          as a line.



FUNCTION DESCRIPTIONS
   VkVuMeter()
           VkVuMeter(char* name, Widget parent)

           virtual void ~VkVuMeter(void);


          VkVuMeter creates a component using the name and parent parameters.

   setValue()
          void setValue(int value, int peak);


          This function changes the currently display value.  A separate peak
          value will also be displayed.  It is expected that peak <= value.

   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
     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