MxScrollBar

MxScrollBar — a user interface element to control scrollable areas.

Functions

ClutterActor * mx_scroll_bar_new ()
ClutterActor * mx_scroll_bar_new_with_adjustment ()
void mx_scroll_bar_set_adjustment ()
MxAdjustment * mx_scroll_bar_get_adjustment ()
void mx_scroll_bar_set_orientation ()
MxOrientation mx_scroll_bar_get_orientation ()

Properties

MxAdjustment * adjustment Read / Write
MxOrientation orientation Read / Write

Signals

void scroll-start Run Last
void scroll-stop Run Last

Types and Values

struct MxScrollBar
struct MxScrollBarClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── ClutterActor
            ╰── MxWidget
                ╰── MxScrollBar

Implemented Interfaces

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

Description

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

Functions

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

Parameters

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.

Parameters

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

Types and Values

struct MxScrollBar

struct MxScrollBar;

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

struct MxScrollBarClass

struct MxScrollBarClass {
  MxWidgetClass parent_class;

  /* signals */
  void (*scroll_start) (MxScrollBar *bar);
  void (*scroll_stop)  (MxScrollBar *bar);

  /* padding for future expansion */
  void (*_padding_0) (void);
  void (*_padding_1) (void);
  void (*_padding_2) (void);
  void (*_padding_3) (void);
  void (*_padding_4) (void);
};

Property Details

The “adjustment” property

  “adjustment”               MxAdjustment *

The adjustment.

Flags: Read / Write

The “orientation” property

  “orientation”              MxOrientation

The orientation of the scrollbar.

Flags: Read / Write

Default value: MX_ORIENTATION_HORIZONTAL

Signal Details

The “scroll-start” signal

void
user_function (MxScrollBar *mxscrollbar,
               gpointer     user_data)

Flags: Run Last

The “scroll-stop” signal

void
user_function (MxScrollBar *mxscrollbar,
               gpointer     user_data)

Flags: Run Last

Generated by GTK-Doc V1.25