RBRating

RBRating — widget for displaying song ratings

Synopsis

struct              RBRating;
struct              RBRatingClass;
RBRating *          rb_rating_new                       (void);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----RBRating

Implemented Interfaces

RBRating implements AtkImplementorIface and GtkBuildable.

Properties

  "rating"                   gdouble               : Read / Write

Signals

  "adjust-rating"                                  : Action
  "rated"                                          : Run Last
  "set-rating"                                     : Action

Description

This widget displays a rating (0-5 stars) and allows the user to alter the rating by clicking.

Details

struct RBRating

struct RBRating;


struct RBRatingClass

struct RBRatingClass {
	GtkWidgetClass parent;

	void (*rated) (RBRating *rating, double score);
	gboolean (*set_rating) (RBRating *rating, double score);
	gboolean (*adjust_rating) (RBRating *rating, double adjust);
};


rb_rating_new ()

RBRating *          rb_rating_new                       (void);

Creates a new rating widget

Returns :

a new RBRating widget.

Property Details

The "rating" property

  "rating"                   gdouble               : Read / Write

The rating displayed in the widget, as a floating point value between 0.0 and 5.0.

Allowed values: [0,5]

Default value: 2.5

Signal Details

The "adjust-rating" signal

void                user_function                      (RBRating *rating,
                                                        gdouble   adjust,
                                                        gpointer  user_data)      : Action

Action signal used to make a relative adjustment to the rating.

rating :

the RBRating

adjust :

value to add to the rating

user_data :

user data set when the signal handler was connected.

The "rated" signal

void                user_function                      (RBRating *rating,
                                                        gdouble   score,
                                                        gpointer  user_data)      : Run Last

Emitted when the user changes the rating.

rating :

the RBRating

score :

the new rating

user_data :

user data set when the signal handler was connected.

The "set-rating" signal

void                user_function                      (RBRating *rating,
                                                        gdouble   score,
                                                        gpointer  user_data)      : Action

Action signal used to change the rating.

rating :

the RBRating

score :

the new rating

user_data :

user data set when the signal handler was connected.