AgsPortlet

AgsPortlet — interfacing portlets

Synopsis

#include <ags/object/ags_portlet.h>

typedef             AgsPortlet;
struct              AgsPortletInterface;
AgsPort *           ags_portlet_get_port                (AgsPortlet *portlet);
GList *             ags_portlet_list_safe_properties    (AgsPortlet *portlet);
void                ags_portlet_safe_get_property       (AgsPortlet *portlet,
                                                         gchar *property_name,
                                                         GValue *value);
void                ags_portlet_safe_set_property       (AgsPortlet *portlet,
                                                         gchar *property_name,
                                                         GValue *value);
void                ags_portlet_set_port                (AgsPortlet *portlet,
                                                         AgsPort *port);

Description

The AgsPortlet interface is intended to use with ports containing GObject. Whereas its should implement this interface.

Details

AgsPortlet

typedef void AgsPortlet;

struct AgsPortletInterface

struct AgsPortletInterface {
  GTypeInterface interface;

  AgsPort* (*get_port)(AgsPortlet *portlet);
  void (*set_port)(AgsPortlet *portlet, AgsPort *port);

  GList* (*list_safe_properties)(AgsPortlet *portlet);

  void (*safe_get_property)(AgsPortlet *portlet, gchar *property_name, GValue *value);
  void (*safe_set_property)(AgsPortlet *portlet, gchar *property_name, GValue *value);
};

ags_portlet_get_port ()

AgsPort *           ags_portlet_get_port                (AgsPortlet *portlet);

Get port.

portlet :

an AgsPortlet

Returns :

the AgsPort

Since 0.4


ags_portlet_list_safe_properties ()

GList *             ags_portlet_list_safe_properties    (AgsPortlet *portlet);

Retrieve thread-safe properties.

portlet :

an AgsPortlet

Returns :

a GList containing properties

Since 0.4


ags_portlet_safe_get_property ()

void                ags_portlet_safe_get_property       (AgsPortlet *portlet,
                                                         gchar *property_name,
                                                         GValue *value);

Get property thread safe.

portlet :

an AgsPortlet

property_name :

propertie's name

value :

the GValue

Since 0.4


ags_portlet_safe_set_property ()

void                ags_portlet_safe_set_property       (AgsPortlet *portlet,
                                                         gchar *property_name,
                                                         GValue *value);

Set property thread safe.

portlet :

an AgsPortlet

property_name :

propertie's name

value :

the GValue

Since 0.4


ags_portlet_set_port ()

void                ags_portlet_set_port                (AgsPortlet *portlet,
                                                         AgsPort *port);

Set port.

portlet :

an AgsPortlet

port :

the AgsPort

Since 0.4