AgsBulkMember

AgsBulkMember — Modify assigned recall's port

Functions

#define AGS_BULK_PORT()
AgsBulkPort * ags_bulk_port_alloc ()
GList * ags_bulk_port_find ()
GtkWidget * ags_bulk_member_get_widget ()
void ags_bulk_member_set_label ()
void ags_bulk_member_change_port ()
GList * ags_bulk_member_find_port ()
AgsBulkMember * ags_bulk_member_new ()
#define AGS_BULK_MEMBER()
#define AGS_BULK_MEMBER_CLASS()
#define AGS_BULK_MEMBER_GET_CLASS()
#define AGS_IS_BULK_MEMBER()
GType ags_bulk_member_get_type ()

Properties

AgsPort * bulk-port Read / Write
gchar * control-port Read / Write
gchar * effect Read / Write
gchar * filename Read / Write
gchar * plugin-name Read / Write
AgsPort * recall-bulk-port Read / Write
gchar * specifier Read / Write
guint steps Read / Write
gulong task-type Read / Write
gchar * widget-label Read / Write
gulong widget-type Read / Write

Signals

void change-port Run Last
gpointer find-port Run Last

Types and Values

#define AGS_BULK_MEMBER_DEFAULT_VERSION
#define AGS_BULK_MEMBER_DEFAULT_BUILD_ID
enum AgsBulkMemberFlags
enum AgsBulkMemberPortFlags
struct AgsBulkPort
#define AGS_TYPE_BULK_MEMBER
struct AgsBulkMember
struct AgsBulkMemberClass

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBin
                        ╰── GtkFrame
                            ╰── AgsBulkMember

Implemented Interfaces

AgsBulkMember implements AtkImplementorIface, GtkBuildable and AgsConnectable.

Includes

#include <ags/X/ags_bulk_member.h>

Description

AgsBulkMember is a composite widget to modify ports of recalls. A bulk member controls only one specific port of a recall but distinguishes between simple/complex recall. It is generally packed into a AgsBulk.

Functions

AGS_BULK_PORT()

#define AGS_BULK_PORT(ptr) ((AgsBulkPort *)(ptr))

ags_bulk_port_alloc ()

AgsBulkPort *
ags_bulk_port_alloc (AgsPort *port);

Allocate AgsBulkPort.

Parameters

port

the AgsPort to set

  

Returns

the newly allocated AgsBulkPort

Since: 1.0.0

ags_bulk_port_find ()

GList *
ags_bulk_port_find (GList *list,
                    AgsPort *port);

Find port within list .

Parameters

list

the GList to search

  

port

the AgsPort to find

  

Returns

the GList containing port if found otherwise NULL

Since: 1.0.0

ags_bulk_member_get_widget ()

GtkWidget *
ags_bulk_member_get_widget (AgsBulkMember *bulk_member);

ags_bulk_member_set_label ()

void
ags_bulk_member_set_label (AgsBulkMember *bulk_member,
                           gchar *label);

Modify the label of the bulk member.

Parameters

bulk_member

an AgsBulkMember

  

label

the label of the control

  

ags_bulk_member_change_port ()

void
ags_bulk_member_change_port (AgsBulkMember *bulk_member,
                             gpointer port_data);

ags_bulk_member_find_port ()

GList *
ags_bulk_member_find_port (AgsBulkMember *bulk_member);

Lookup ports of assigned recalls.

Parameters

bulk_member

an AgsBulkMember

  

Returns

an GList containing all related AgsPort

Since: 1.0.0

ags_bulk_member_new ()

AgsBulkMember *
ags_bulk_member_new ();

Creates an AgsBulkMember

Returns

a new AgsBulkMember

Since: 1.0.0

AGS_BULK_MEMBER()

#define AGS_BULK_MEMBER(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_BULK_MEMBER, AgsBulkMember))

AGS_BULK_MEMBER_CLASS()

#define AGS_BULK_MEMBER_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_BULK_MEMBER, AgsBulkMemberClass))

AGS_BULK_MEMBER_GET_CLASS()

#define AGS_BULK_MEMBER_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_BULK_MEMBER, AgsBulkMemberClass))

AGS_IS_BULK_MEMBER()

#define AGS_IS_BULK_MEMBER(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_BULK_MEMBER))

ags_bulk_member_get_type ()

GType
ags_bulk_member_get_type (void);

Types and Values

AGS_BULK_MEMBER_DEFAULT_VERSION

#define AGS_BULK_MEMBER_DEFAULT_VERSION "0.7.21\0"

AGS_BULK_MEMBER_DEFAULT_BUILD_ID

#define AGS_BULK_MEMBER_DEFAULT_BUILD_ID "CEST 01-03-2016 00:23\0"

enum AgsBulkMemberFlags

Members

AGS_BULK_MEMBER_CONNECTED

    

AGS_BULK_MEMBER_DEFAULT_TEMPLATE

    

AGS_BULK_MEMBER_RESET_BY_ATOMIC

    

AGS_BULK_MEMBER_RESET_BY_TASK

    

AGS_BULK_MEMBER_APPLY_RECALL

    

AGS_BULK_MEMBER_NO_UPDATE

    

AGS_BULK_MEMBER_APPLY_INITIAL

    

enum AgsBulkMemberPortFlags

Members

AGS_BULK_MEMBER_PORT_BOOLEAN

    

AGS_BULK_MEMBER_PORT_INTEGER

    

struct AgsBulkPort

struct AgsBulkPort {
  AgsPort *port;
  gpointer port_data;
  gboolean active;
};

AGS_TYPE_BULK_MEMBER

#define AGS_TYPE_BULK_MEMBER                (ags_bulk_member_get_type())

struct AgsBulkMember

struct AgsBulkMember;

struct AgsBulkMemberClass

struct AgsBulkMemberClass {
  GtkFrameClass frame;

  void (*change_port)(AgsBulkMember *bulk_member,
		      gpointer port_data);

  GList* (*find_port)(AgsBulkMember *bulk_member);
};

Property Details

The “bulk-port” property

  “bulk-port”                AgsPort *

The playback bulk port to be added.

Flags: Read / Write

Since: 1.0.0

The “control-port” property

  “control-port”             gchar *

The control port of the recall.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “effect” property

  “effect”                   gchar *

The plugin effect of the recall to apply.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “filename” property

  “filename”                 gchar *

The plugin filename of the recall to apply.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “plugin-name” property

  “plugin-name”              gchar *

The plugin name of the recall to use.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “recall-bulk-port” property

  “recall-bulk-port”         AgsPort *

The recall bulk port to be added.

Flags: Read / Write

Since: 1.0.0

The “specifier” property

  “specifier”                gchar *

The plugin specifier of the recall to apply.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “steps” property

  “steps”                    guint

If bulk member has integer ports, this is the number of steps.

Flags: Read / Write

Default value: 8

Since: 1.0.0

The “task-type” property

  “task-type”                gulong

The task type to apply the ports.

Flags: Read / Write

Since: 1.0.0

The “widget-label” property

  “widget-label”             gchar *

The widget's label to use.

Flags: Read / Write

Default value: NULL

Since: 1.0.0

The “widget-type” property

  “widget-type”              gulong

The widget type to instantiate and use as control.

Flags: Read / Write

Since: 1.0.0

Signal Details

The “change-port” signal

void
user_function (AgsBulkMember *bulk_member,
               gpointer       port_data,
               gpointer       user_data)

The ::change-port signal notifies modified port.

Parameters

bulk_member

the AgsBulkMember

  

port_data

the port's data

  

user_data

user data set when the signal handler was connected.

  

Flags: Run Last

Since: 1.0.0

The “find-port” signal

gpointer
user_function (AgsBulkMember *bulk_member,
               gpointer       user_data)

The ::find-port as recall should be mapped

Parameters

bulk_member

the AgsBulkMember to resize

  

user_data

user data set when the signal handler was connected.

  

Returns

a GList with associated ports

Flags: Run Last

Since: 1.0.0

Generated by GTK-Doc V1.25