GiwShow
GiwShow - A show widget


Synopsis
#include <giwshow.h>


                       
      GiwShow;
GtkWidget*   
        giw_show_new                                  (GtkAdjustment *adjustment);
GtkWidget*    
       giw_show_new_with_adjusment      (gdouble min, gdouble max, gdouble value);
gdouble                 giw_show_get_value                         (GiwShow *show);
void                       giw_show_set_value                         (GiwShow *show, gdouble value);
GtkAdjustment*    giw_show_get_adjustment               (GiwShow *show);
void                       giw_show_set_adjustment               (GiwShow *show, GtkAdjustment *adjustment);
void                       giw_show_set_legends_digits          (GiwShow *show, guint digits_number);
void                       giw_show_set_ticks_number            (GiwShow *show, guint major, guint minor);
void                       giw_show_set_mouse_policy            (GiwShow *show, GiwShowMousePolicy policy);
void                       giw_show_set_title                            (GiwShow *show, gchar *str);


Object Hierarchy
GObject
   +----GtkObject
           +----GtkWidget
                    +----GiwShow

Description

GiwShow is a show, with the legends and the pointer.
It can be created with a giw_show_new(), an cofigured with the functions below. If you want to connect signals with it, you have to connect them to the adjustment it uses, wich can be acessed by
giw_show_get_adjustment.   

Details

GiwShow
typedef struct GiwShow _GiwShow

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

giw_show_new()

GtkWidget*     giw_show_new                                       (GtkAdjustment *adjustment);

Creates a new show, with all default options and the adjustment sent as a parementer (only the fields value, lower and upper are used).

adjustment: The adjustment to be used (it will define the value, and the lower and upper values of the show).
Returns: a new show.

giw_show_new_with_adjusment()

GtkWidget*           giw_show_new_with_adjusment      (gdouble min, gdouble max, gdouble value);

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

min
: The lower value.
max: The upper value.
value: The initial value.
Returns: A new show.

giw_show_get_value()

gdouble                 giw_show_get_value                         (GiwShow *show);

Gets the current value of the show.


show: A show.
Return: The value.

giw_show_set_value()

void                       giw_show_set_value                         (GiwShow *show, gdouble value);

Sets the current value of the show.


show: A show.
value
: The desired value.

giw_show_get_adjustment()

GtkAdjustment*    giw_show_get_adjustment               (GiwShow *show);

Gets the adjusment that the show uses.


show: A show.
Return
: The adjusment.

giw_show_set_adjustment()

void                       giw_show_set_adjustment               (GiwShow *show, GtkAdjustment *adjustment);

Sets a new adjusment to be used.


show: A show.
adjustment
: The new adjusment.

giw_show_set_legends_digits()

void                       giw_show_set_legends_digits          (GiwShow *show, guint digits_number);

Sets the number of digits that the legends will use (including the "." and "-" if it exists). If you don't want legends, you can set "0" here.


show: A show.
digits_number
: The number of digits.

giw_show_set_ticks_number()

void                       giw_show_set_ticks_number            (GiwShow *show, guint major, guint minor);

Sets the number ticks in the show.


show: A show.
major
: The number of major ticks in the show.
minor: The number of minor ticks between each two major ticks.

giw_show_set_mouse_policy()

void                       giw_show_set_mouse_policy            (GiwShow *show, GiwShowMousePolicy policy);

Sets the policy to use mouse to change the show's value.
The default option is GIW_SHOW_MOUSE_DISABLED.

show: A show.
policy
: The chosen policy to be used.

enum GiwShowMousePolicy

typedef enum{
  GIW_SHOW_MOUSE_DISABLED,
  GIW_SHOW_MOUSE_AUTOMATICALLY,
  GIW_SHOW_MOUSE_DELAYED
}GiwShowMousePolicy;

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

giw_show_set_title()

void                       giw_show_set_title                            (GiwShow *show, gchar *str);

Sets the title, it it be in the bottom of the show. The not show any title, set it to NULL.

show: A show.
str
: The string with the title.