AgsPortlet: Advanced Gtk+ Sequencer Reference Manual

AgsPortlet

AgsPortlet — interfacing portlets

Stability Level

Stable, unless otherwise indicated

Functions

GObject *	ags_portlet_get_port ()
void	ags_portlet_set_port ()
GList *	ags_portlet_list_safe_properties ()
void	ags_portlet_safe_get_property ()
void	ags_portlet_safe_set_property ()
#define	AGS_IS_PORTLET()
#define	AGS_IS_PORTLET_INTERFACE()
#define	AGS_PORTLET()
#define	AGS_PORTLET_GET_INTERFACE()
#define	AGS_PORTLET_INTERFACE()
GType	ags_portlet_get_type ()

Types and Values

#define	AGS_TYPE_PORTLET
	AgsPortlet
struct	AgsPortletInterface

Object Hierarchy

    GInterface
    ╰── AgsPortlet

Includes

#include <ags/object/ags_portlet.h>

Description

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

Functions

ags_portlet_get_port ()

GObject *
ags_portlet_get_port (AgsPortlet *portlet);

Get port.

Parameters

portlet

the AgsPortlet

Returns

the GObject.

[transfer full]

Since: 3.0.0

ags_portlet_set_port ()

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

Set port.

Parameters

portlet	the AgsPortlet
port	the GObject

Since: 3.0.0

ags_portlet_list_safe_properties ()

GList *
ags_portlet_list_safe_properties (AgsPortlet *portlet);

Retrieve thread-safe properties.

Parameters

portlet

the AgsPortlet

Returns

a GList containing properties.

[element-type utf8][transfer full]

Since: 3.0.0

ags_portlet_safe_get_property ()

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

Get property thread safe.

Parameters

portlet	the AgsPortlet
property_name	propertie's name
value	the GValue

Since: 3.0.0

ags_portlet_safe_set_property ()

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

Set property thread safe.

Parameters

portlet	the AgsPortlet
property_name	propertie's name
value	the GValue

Since: 3.0.0

AGS_IS_PORTLET()

#define AGS_IS_PORTLET(obj)                 (G_TYPE_CHECK_INSTANCE_TYPE((obj), AGS_TYPE_PORTLET))

AGS_IS_PORTLET_INTERFACE()

#define AGS_IS_PORTLET_INTERFACE(vtable)    (G_TYPE_CHECK_CLASS_TYPE((vtable), AGS_TYPE_PORTLET))

AGS_PORTLET()

#define AGS_PORTLET(obj)                    (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_PORTLET, AgsPortlet))

AGS_PORTLET_GET_INTERFACE()

#define AGS_PORTLET_GET_INTERFACE(obj)      (G_TYPE_INSTANCE_GET_INTERFACE((obj), AGS_TYPE_PORTLET, AgsPortletInterface))

AGS_PORTLET_INTERFACE()

#define AGS_PORTLET_INTERFACE(vtable)       (G_TYPE_CHECK_CLASS_CAST((vtable), AGS_TYPE_PORTLET, AgsPortletInterface))

ags_portlet_get_type ()

GType
ags_portlet_get_type ();

Types and Values

AGS_TYPE_PORTLET

#define AGS_TYPE_PORTLET                    (ags_portlet_get_type())

AgsPortlet

typedef struct _AgsPortlet AgsPortlet;

struct AgsPortletInterface

struct AgsPortletInterface {
  GTypeInterface ginterface;

  GObject* (*get_port)(AgsPortlet *portlet);
  void (*set_port)(AgsPortlet *portlet, GObject *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);
};