MxScrollBar

MxScrollBar — a user interface element to control scrollable areas.

Synopsis

struct              MxScrollBar;
ClutterActor *      mx_scroll_bar_new                   (void);
ClutterActor *      mx_scroll_bar_new_with_adjustment   (MxAdjustment *adjustment);
void                mx_scroll_bar_set_adjustment        (MxScrollBar *bar,
                                                         MxAdjustment *adjustment);
MxAdjustment *      mx_scroll_bar_get_adjustment        (MxScrollBar *bar);
void                mx_scroll_bar_set_orientation       (MxScrollBar *bar,
                                                         MxOrientation orientation);
MxOrientation       mx_scroll_bar_get_orientation       (MxScrollBar *bar);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----ClutterActor
               +----MxWidget
                     +----MxBin
                           +----MxScrollBar

Implemented Interfaces

MxScrollBar implements ClutterScriptable, ClutterAnimatable, AtkImplementorIface, MxStylable, ClutterContainer and MxFocusable.

Properties

  "adjustment"               MxAdjustment*         : Read / Write
  "orientation"              MxOrientation         : Read / Write

Signals

  "scroll-start"                                   : Run Last
  "scroll-stop"                                    : Run Last

Description

The MxScrollBar allows users to scroll scrollable actors, either by the step or page amount, or by manually dragging the handle.

Details

struct MxScrollBar

struct MxScrollBar;

The contents of this structure are private and should only be accessed through the public API.


mx_scroll_bar_new ()

ClutterActor *      mx_scroll_bar_new                   (void);

Create a new MxScrollBar

Returns :

a new MxScrollBar

mx_scroll_bar_new_with_adjustment ()

ClutterActor *      mx_scroll_bar_new_with_adjustment   (MxAdjustment *adjustment);

Create a new MxScrollBar with the given adjustment set

adjustment :

an MxAdjustment

Returns :

a new MxScrollBar

mx_scroll_bar_set_adjustment ()

void                mx_scroll_bar_set_adjustment        (MxScrollBar *bar,
                                                         MxAdjustment *adjustment);


mx_scroll_bar_get_adjustment ()

MxAdjustment *      mx_scroll_bar_get_adjustment        (MxScrollBar *bar);

Gets the adjustment object that stores the current position of the scrollbar.

bar :

a MxScrollBar

Returns :

the adjustment. [transfer none]

mx_scroll_bar_set_orientation ()

void                mx_scroll_bar_set_orientation       (MxScrollBar *bar,
                                                         MxOrientation orientation);


mx_scroll_bar_get_orientation ()

MxOrientation       mx_scroll_bar_get_orientation       (MxScrollBar *bar);

Property Details

The "adjustment" property

  "adjustment"               MxAdjustment*         : Read / Write

The adjustment.


The "orientation" property

  "orientation"              MxOrientation         : Read / Write

The orientation of the scrollbar.

Default value: MX_ORIENTATION_HORIZONTAL

Signal Details

The "scroll-start" signal

void                user_function                      (MxScrollBar *mxscrollbar,
                                                        gpointer     user_data)        : Run Last

mxscrollbar :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "scroll-stop" signal

void                user_function                      (MxScrollBar *mxscrollbar,
                                                        gpointer     user_data)        : Run Last

mxscrollbar :

the object which received the signal.

user_data :

user data set when the signal handler was connected.