pidgin  2.13.0
About: Pidgin is a chat program (multi-protocol instant messaging client) which lets you log in to accounts on multiple chat networks simultaneously (old name "gaim").
  Fossies Dox: pidgin-2.13.0.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

gntslider.h File Reference
#include "gntwidget.h"
#include "gnt.h"
#include "gntlabel.h"
Include dependency graph for gntslider.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _GntSlider
 
struct  _GntSliderClass
 

Macros

#define GNT_TYPE_SLIDER   (gnt_slider_get_gtype())
 
#define GNT_SLIDER(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_SLIDER, GntSlider))
 
#define GNT_SLIDER_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_SLIDER, GntSliderClass))
 
#define GNT_IS_SLIDER(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_SLIDER))
 
#define GNT_IS_SLIDER_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_SLIDER))
 
#define GNT_SLIDER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_SLIDER, GntSliderClass))
 
#define GNT_SLIDER_FLAGS(obj)   (GNT_SLIDER(obj)->priv.flags)
 
#define GNT_SLIDER_SET_FLAGS(obj, flags)   (GNT_SLIDER_FLAGS(obj) |= flags)
 
#define GNT_SLIDER_UNSET_FLAGS(obj, flags)   (GNT_SLIDER_FLAGS(obj) &= ~(flags))
 
#define gnt_hslider_new(max, min)   gnt_slider_new(FALSE, max, min)
 
#define gnt_vslider_new(max, min)   gnt_slider_new(TRUE, max, min)
 

Typedefs

typedef struct _GntSlider GntSlider
 
typedef struct _GntSliderPriv GntSliderPriv
 
typedef struct _GntSliderClass GntSliderClass
 

Functions

G_BEGIN_DECLS GType gnt_slider_get_gtype (void)
 
GntWidgetgnt_slider_new (gboolean orient, int max, int min)
 
void gnt_slider_set_range (GntSlider *slider, int max, int min)
 
void gnt_slider_set_step (GntSlider *slider, int step)
 
void gnt_slider_set_small_step (GntSlider *slider, int step)
 
void gnt_slider_set_large_step (GntSlider *slider, int step)
 
int gnt_slider_advance_step (GntSlider *slider, int steps)
 
void gnt_slider_set_value (GntSlider *slider, int value)
 
int gnt_slider_get_value (GntSlider *slider)
 
void gnt_slider_reflect_label (GntSlider *slider, GntLabel *label)
 

Detailed Description

Slider API

Definition in file gntslider.h.

Macro Definition Documentation

◆ gnt_hslider_new

#define gnt_hslider_new (   max,
  min 
)    gnt_slider_new(FALSE, max, min)

Definition at line 83 of file gntslider.h.

◆ GNT_IS_SLIDER

#define GNT_IS_SLIDER (   obj)    (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_SLIDER))

Definition at line 37 of file gntslider.h.

◆ GNT_IS_SLIDER_CLASS

#define GNT_IS_SLIDER_CLASS (   klass)    (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_SLIDER))

Definition at line 38 of file gntslider.h.

◆ GNT_SLIDER

#define GNT_SLIDER (   obj)    (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_SLIDER, GntSlider))

Definition at line 35 of file gntslider.h.

◆ GNT_SLIDER_CLASS

#define GNT_SLIDER_CLASS (   klass)    (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_SLIDER, GntSliderClass))

Definition at line 36 of file gntslider.h.

◆ GNT_SLIDER_FLAGS

#define GNT_SLIDER_FLAGS (   obj)    (GNT_SLIDER(obj)->priv.flags)

Definition at line 41 of file gntslider.h.

◆ GNT_SLIDER_GET_CLASS

#define GNT_SLIDER_GET_CLASS (   obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_SLIDER, GntSliderClass))

Definition at line 39 of file gntslider.h.

◆ GNT_SLIDER_SET_FLAGS

#define GNT_SLIDER_SET_FLAGS (   obj,
  flags 
)    (GNT_SLIDER_FLAGS(obj) |= flags)

Definition at line 42 of file gntslider.h.

◆ GNT_SLIDER_UNSET_FLAGS

#define GNT_SLIDER_UNSET_FLAGS (   obj,
  flags 
)    (GNT_SLIDER_FLAGS(obj) &= ~(flags))

Definition at line 43 of file gntslider.h.

◆ GNT_TYPE_SLIDER

#define GNT_TYPE_SLIDER   (gnt_slider_get_gtype())

Definition at line 34 of file gntslider.h.

◆ gnt_vslider_new

#define gnt_vslider_new (   max,
  min 
)    gnt_slider_new(TRUE, max, min)

Definition at line 84 of file gntslider.h.

Typedef Documentation

◆ GntSlider

typedef struct _GntSlider GntSlider

Definition at line 45 of file gntslider.h.

◆ GntSliderClass

Definition at line 47 of file gntslider.h.

◆ GntSliderPriv

typedef struct _GntSliderPriv GntSliderPriv

Definition at line 46 of file gntslider.h.

Function Documentation

◆ gnt_slider_advance_step()

int gnt_slider_advance_step ( GntSlider slider,
int  steps 
)

Advance the slider forward or backward.

Parameters
sliderThe slider
stepsThe number of amounts to change, positive to change forward, negative to change backward
Returns
The value of the slider after the change
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 304 of file gntslider.c.

References _GntSlider::current, gnt_slider_set_value(), and _GntSlider::step.

Referenced by step_back(), and step_forward().

Here is the caller graph for this function:

◆ gnt_slider_get_gtype()

G_BEGIN_DECLS GType gnt_slider_get_gtype ( void  )
Returns
The GType for GntSlider
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 239 of file gntslider.c.

References gnt_slider_class_init(), gnt_slider_init(), GNT_TYPE_WIDGET, info, NULL, and dbus-analyze-signals::type.

◆ gnt_slider_get_value()

int gnt_slider_get_value ( GntSlider slider)

Get the current value for the slider.

Parameters
sliderThe slider
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 299 of file gntslider.c.

References _GntSlider::current.

Referenced by save_cb(), and test_cb().

Here is the caller graph for this function:

◆ gnt_slider_new()

GntWidget* gnt_slider_new ( gboolean  orient,
int  max,
int  min 
)

Create a new slider.

Parameters
orientA vertical slider is created if TRUE, otherwise the slider is horizontal.
maxThe maximum value for the slider
minThe minimum value for the slider
Returns
The newly created slider
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 266 of file gntslider.c.

References GNT_SLIDER, gnt_slider_set_range(), GNT_TYPE_SLIDER, GNT_WIDGET_GROW_X, GNT_WIDGET_GROW_Y, GNT_WIDGET_SET_FLAGS, max, min, NULL, _GntSlider::step, _GntSlider::vertical, and widget.

Referenced by finch_sounds_show_all().

Here is the caller graph for this function:

◆ gnt_slider_reflect_label()

void gnt_slider_reflect_label ( GntSlider slider,
GntLabel label 
)

Update a label with the value of the slider whenever the value changes.

Parameters
sliderThe slider
labelThe label to update
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 340 of file gntslider.c.

References label, and update_label().

Referenced by finch_sounds_show_all().

Here is the caller graph for this function:

◆ gnt_slider_set_large_step()

void gnt_slider_set_large_step ( GntSlider slider,
int  step 
)

Sets the amount of change a large step.

Parameters
sliderThe slider
stepThe amount for a large step (for the slider)
Since
2.2.0

Definition at line 320 of file gntslider.c.

References _GntSlider::largestep.

Referenced by finch_sounds_show_all().

Here is the caller graph for this function:

◆ gnt_slider_set_range()

void gnt_slider_set_range ( GntSlider slider,
int  max,
int  min 
)

Set the range of the slider.

Parameters
sliderThe slider
maxThe maximum value
minThe minimum value
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 325 of file gntslider.c.

References _GntSlider::max, max, min, _GntSlider::min, and sanitize_value().

Referenced by gnt_slider_new().

Here is the caller graph for this function:

◆ gnt_slider_set_small_step()

void gnt_slider_set_small_step ( GntSlider slider,
int  step 
)

Sets the amount of change a small step.

Parameters
sliderThe slider
stepThe amount for a small step (for the slider)
Since
2.2.0

Definition at line 315 of file gntslider.c.

References _GntSlider::smallstep.

Referenced by finch_sounds_show_all().

Here is the caller graph for this function:

◆ gnt_slider_set_step()

void gnt_slider_set_step ( GntSlider slider,
int  step 
)

Sets the amount of change at each step.

Parameters
sliderThe slider
stepThe amount for each step
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 310 of file gntslider.c.

References _GntSlider::step.

Referenced by finch_sounds_show_all().

Here is the caller graph for this function:

◆ gnt_slider_set_value()

void gnt_slider_set_value ( GntSlider slider,
int  value 
)

Set the current value for the slider.

Parameters
sliderThe slider
valueThe current value
Since
2.0.0 (gnt), 2.1.0 (pidgin)

Definition at line 285 of file gntslider.c.

References _GntSlider::current, redraw_slider(), sanitize_value(), slider_value_changed(), and value.

Referenced by gnt_slider_advance_step(), large_step_back(), large_step_forward(), load_pref_window(), move_max_value(), move_min_value(), small_step_back(), and small_step_forward().

Here is the caller graph for this function: