GiwVSlider
GiwVSlider - A vslider widget


Synopsis
#include <giwvslider.h>


                           GiwVSlider;
GtkWidget*        giw_vslider_new                        
              (GtkAdjustment *adjustment);
GtkWidget*        giw_vslider_new_with_adjustment          (gdouble value, gdouble lower, gdouble upper);
void                    giw_vslider_set_value                              (GiwVSlider *vslider, gdouble value);  
gdouble              giw_vslider_get_value                              (GiwVSlider *vslider);  
GtkAdjustment* giw_vslider_get_adjustment                    (GiwVSlider *vslider);
void                    giw_vslider_set_adjustment                     (GiwVSlider *vslider, GtkAdjustment *adjustment);
void                    giw_vslider_set_legends_digits                 (GiwVSlider *vslider, int digits);
void                    giw_vslider_set_mouse_policy                 (GiwVSlider *vslider,  GiwVSliderMousePolicy policy);
void                    giw_vslider_set_major_ticks_number     (GiwVSlider *vslider, gint number);
void                    giw_vslider_set_minor_ticks_number     (GiwVSlider *vslider, gint number);

Object Hierarchy
GObject
   +----GtkObject
           +----GtkWidget
                    +----GiwVSlider

Description

GiwVSlider is a vslider like a mercury vslider. It has the column (like the mercury column) and the legends, a title and a label representing the current value.
It can be created with a giw_vslider_new(), an cofigured with the functions below.
The receive signals when the value is changed, get the adjustment of the vslider and receive the signal from it.

Details

GiwVSlider
typedef struct GiwVSlider _GiwVSlider

The GiwVSlider struct contains private data only, and should be manipulated using the functions below.

giw_vslider_new()

GtkWidget*     giw_vslider_new                         (void);

Creates a new vslider, with all default options.

Returns: a new vslider.

giw_vslider_new_with_adjustment()

GtkWidget*        giw_vslider_new_with_adjustment          (gdouble value, gdouble lower, gdouble upper);

A convenience function, wich don't need to receive a adjustement as paramenter, but his fields.

min: The lower value.
upper: The upper value.
lower: The initial value.
Returns: a new vslider.

giw_vslider_get_adjustment()

GtkAdjustment*    giw_vslider_get_adjustment               (GiwVSlider *vslider);

Gets the adjusment that the vslider uses.


vslider: A vslider.
Return
: The adjusment.

giw_vslider_set_adjustment()

void                       giw_vslider_set_adjustment               (GiwVSlider *vslider, GtkAdjustment *adjustment);

Sets a new adjusment to be used.


vslider: A vslider.
adjustment
: The new adjusment.
giw_vslider_set_value()

void                 giw_vslider_set_value                (GiwVSlider *vslider, gdouble value);  

Sets the value (the size of the column) of the vslider,  is has to be between the min_value and max_value (wich can be set with the gtk_temometer_set_min_value and
gtk_temometer_set_max_value), or nothing will be drawn. The default value is 50.

vslider: A vslider.
value: The new value.

giw_vslider_get_value()

gdouble            giw_vslider_set_value                (GiwVSlider *vslider);  

Gets the value (the size of the column) of the vslider.

vslider: A vslider.
Returns: The value.

giw_vslider_set_legends_digits()

void                 giw_vslider_set_legends_digits   (GiwVSlider *vslider, int digits);

Sets the number os digits to be used by the legends (counting the "." and the signal "-" if exists). If no legends is desired, set the digits to 0. The default is 5.


vslider: A vslider.
digits: The number of digits.

giw_vslider_set_mouse_policy()

void                    giw_vslider_set_mouse_policy                 (GiwVSlider *vslider,  GiwVSliderMousePolicy policy);

Sets the policy for using mouse on changing vslider's value

vslider: A vslider.
policy: The policy to be used.

enum GiwVSliderMousePolicy

typedef enum{
  GIW_VSLIDER_MOUSE_DISABLED,
  GIW_VSLIDER_MOUSE_AUTOMATICALLY,
  GIW_VSLIDER_MOUSE_DELAYED
}GiwVSliderMousePolicy;

Used to set the way the mouse will be used.
 
    GIW_VSLIDER_MOUSE_DISABLED                Mouse can't be used to change value.
    GIW_VSLIDER_MOUSE_AUTOMATICALLY    The pointer folows mouse aftre a button is pressed.
    GIW_VSLIDER_MOUSE_DELAYED                  The pointer assumes mouse position only when the button is relased.


giw_vslider_set_major_ticks_number()

void                 giw_vslider_set_major_ticks_number     (GiwVSlider *vslider, gint number);

Sets the number oj major ticks to be drawn in all the vslider, if it's 0, there are no ticks (and no legends too).

vslider: A vslider.
option: The number of ticks desired.

giw_vslider_set_minor_ticks_number()

void                 giw_vslider_set_minor_ticks_number     (GiwVSlider *vslider, gint number);

Sets the number oj minor ticks to be drawn between each major ticks, if it's 0 there are no minor ticks.

vslider: A vslider.
option: The number of minor ticks desired.