AgsLine

AgsLine — A composite widget to visualize AgsChannel

Functions

Properties

AgsChannel * channel Read / Write
AgsPad * pad Read / Write

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkObject
            ╰── GtkWidget
                ╰── GtkContainer
                    ╰── GtkBox
                        ╰── GtkVBox
                            ╰── AgsLine
                                ├── AgsDrumInputLine
                                ├── AgsDrumOutputLine
                                ├── AgsMixerInputLine
                                ├── AgsPanelInputLine
                                ╰── AgsSynthInputLine

Implemented Interfaces

AgsLine implements AtkImplementorIface, GtkBuildable, GtkOrientable, AgsConnectable and AgsPlugin.

Includes

#include <ags/X/ags_line.h>

Description

AgsLine is a composite widget to visualize AgsChannel. It should be packed by an AgsPad. It may contain AgsLineMember to modify ports of AgsRecall.

Functions

ags_line_set_channel ()

void
ags_line_set_channel (AgsLine *line,
                      AgsChannel *channel);

Is emitted as channel gets modified.

Parameters

line

an AgsLine

 

channel

the AgsChannel to set

 

Since: 1.0.0


ags_line_group_changed ()

void
ags_line_group_changed (AgsLine *line);

Is emitted as group is changed.

Parameters

line

an AgsLine

 

Since: 1.0.0


ags_line_add_effect ()

GList *
ags_line_add_effect (AgsLine *line,
                     GList *control_type_name,
                     gchar *filename,
                     gchar *effect);

Add a line member.

Parameters

line

the AgsLine

 

control_type_name

the control GType string representation

 

filename

the filename of the plugin

 

effect

the effect's name

 

Returns

a GList containing new AgsPort objects

Since: 1.0.0


ags_line_remove_effect ()

void
ags_line_remove_effect (AgsLine *line,
                        guint nth);

Remove a line member.

Parameters

line

the AgsLine

 

nth

nth effect to remove

 

Since: 1.0.0


ags_line_map_recall ()

void
ags_line_map_recall (AgsLine *line,
                     guint output_pad_start);

Is emitted as group is changed.

Parameters

line

an AgsLine

 

output_pad_start

the start pad

 

Since: 1.0.0


ags_line_find_port ()

GList *
ags_line_find_port (AgsLine *line);

Lookup ports of assigned recalls.

Parameters

line

an AgsLine

 

Returns

an GList containing all related AgsPort

Since: 1.0.0


ags_line_find_next_grouped ()

GList *
ags_line_find_next_grouped (GList *line);

Retrieve next grouped line.

Parameters

line

a GList of AgsLine objects

 

Returns

next matching GList containing AgsLine

Since: 1.0.0


ags_line_indicator_queue_draw_timeout ()

gboolean
ags_line_indicator_queue_draw_timeout (GtkWidget *widget);

Queue draw widget

Parameters

widget

the indicator widgt

 

Returns

TRUE if proceed with redraw, otherwise FALSE

Since: 1.0.0


ags_line_new ()

AgsLine *
ags_line_new (GtkWidget *pad,
              AgsChannel *channel);

Creates an AgsLine

Parameters

pad

the parent pad

 

channel

the channel to visualize

 

Returns

a new AgsLine

Since: 1.0.0


AGS_IS_LINE()

#define AGS_IS_LINE(obj)             (G_TYPE_CHECK_INSTANCE_TYPE ((obj), AGS_TYPE_LINE))

AGS_LINE()

#define AGS_LINE(obj)                (G_TYPE_CHECK_INSTANCE_CAST((obj), AGS_TYPE_LINE, AgsLine))

AGS_LINE_CLASS()

#define AGS_LINE_CLASS(class)        (G_TYPE_CHECK_CLASS_CAST((class), AGS_TYPE_LINE, AgsLineClass))

AGS_LINE_GET_CLASS()

#define AGS_LINE_GET_CLASS(obj)      (G_TYPE_INSTANCE_GET_CLASS ((obj), AGS_TYPE_LINE, AgsLineClass))

ags_line_get_type ()

GType
ags_line_get_type (void);

Types and Values

AGS_LINE_DEFAULT_VERSION

#define AGS_LINE_DEFAULT_VERSION "0.7.0\0"

AGS_LINE_DEFAULT_BUILD_ID

#define AGS_LINE_DEFAULT_BUILD_ID "CEST 31-10-2015 19:49\0"

AGS_LINE_COLUMNS_COUNT

#define AGS_LINE_COLUMNS_COUNT (2)

AGS_LINE_SEPARATOR_FILENAME

#define AGS_LINE_SEPARATOR_FILENAME "ags-line-separator-filename\0"

AGS_LINE_SEPARATOR_EFFECT

#define AGS_LINE_SEPARATOR_EFFECT "ags-line-separator-effect\0"

enum AgsLineFlags

Members

AGS_LINE_CONNECTED

   

AGS_LINE_GROUPED

   

AGS_LINE_MAPPED_RECALL

   

AGS_LINE_PREMAPPED_RECALL

   

AGS_TYPE_LINE

#define AGS_TYPE_LINE                (ags_line_get_type())

struct AgsLine

struct AgsLine;

struct AgsLineClass

struct AgsLineClass {
  GtkVBoxClass vbox;

  void (*set_channel)(AgsLine *line, AgsChannel *channel);

  void (*group_changed)(AgsLine *line);
  
  GList* (*add_effect)(AgsLine *line,
		       GList *control_type_name,
		       gchar *filename,
		       gchar *effect);
  void (*remove_effect)(AgsLine *line,
			guint nth);
  
  void (*map_recall)(AgsLine *line,
		     guint output_pad_start);
  GList* (*find_port)(AgsLine *line);
};

Property Details

The “channel” property

  “channel”                  AgsChannel *

The assigned AgsChannel to visualize.

Flags: Read / Write

Since: 1.0.0


The “pad” property

  “pad”                      AgsPad *

The assigned AgsPad.

Flags: Read / Write

Since: 1.0.0

Signal Details

The “add-effect” signal

gpointer
user_function (AgsLine *line,
               gpointer control_type_name,
               gchar   *filename,
               gchar   *effect,
               gpointer user_data)

The ::add-effect signal notifies about added effect.

Parameters

line

the AgsLine to modify

 

control_type_name

the control GType string representation

 

filename

the effect's filename

 

effect

the effect's name

 

user_data

user data set when the signal handler was connected.

 

Returns

a GList containing new AgsPort objects

Flags: Run Last

Since: 1.0.0


The “find-port” signal

gpointer
user_function (AgsLine *line,
               gpointer user_data)

The ::find-port retrieves all associated ports.

Parameters

line

the AgsLine

 

user_data

user data set when the signal handler was connected.

 

Returns

a GList with associated ports

Flags: Run Last

Since: 1.0.0


The “group-changed” signal

void
user_function (AgsLine *line,
               gpointer user_data)

The ::group-changed signal notifies about changed grouping. This normally happens as toggling group button in AgsPad or AgsLine.

Parameters

line

the object group changed

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0


The “map-recall” signal

void
user_function (AgsLine *line,
               guint    output_pad_start,
               gpointer user_data)

The ::map-recall as recalls should be mapped.

Parameters

line

the AgsLine

 

output_pad_start

the channels start pad

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0


The “remove-effect” signal

void
user_function (AgsLine *line,
               guint    nth,
               gpointer user_data)

The ::remove-effect signal notifies about removed effect.

Parameters

line

the AgsLine to modify

 

nth

the nth effect

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0


The “set-channel” signal

void
user_function (AgsLine *line,
               GObject *channel,
               gpointer user_data)

The ::set-channel signal notifies about changed channel.

Parameters

line

the AgsLine to modify

 

channel

the AgsChannel to set

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last

Since: 1.0.0