gtk_lineObjectWidget

gtk_lineObjectWidget — Defines a specialised GtkBox to choose all characteristic of lines.

Synopsis

                    VisuUiLine;
                    VisuUiLineClass;
GtkWidget *         visu_ui_line_getOptionBox           (VisuUiLine *line);
GtkWidget *         visu_ui_line_new                    (const gchar *label);
void                visu_ui_line_setColor               (VisuUiLine *line,
                                                         float rgb[3]);
void                visu_ui_line_setStipple             (VisuUiLine *line,
                                                         guint16 stipple);
void                visu_ui_line_setUsed                (VisuUiLine *line,
                                                         gboolean status);
void                visu_ui_line_setWidth               (VisuUiLine *line,
                                                         gint width);

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GtkWidget
               +----GtkContainer
                     +----GtkBox
                           +----GtkVBox
                                 +----VisuUiLine

Implemented Interfaces

VisuUiLine implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Signals

  "color-changed"                                  : Action
  "stipple-changed"                                : Action
  "use-changed"                                    : Action
  "width-changed"                                  : Action

Description

Details

VisuUiLine

typedef struct _VisuUiLine VisuUiLine;

Private structure to store informations of a VisuUiLine object.

Since 3.4


VisuUiLineClass

typedef struct _VisuUiLineClass VisuUiLineClass;

Private structure to store informations of a VisuUiLineClass object.

Since 3.4


visu_ui_line_getOptionBox ()

GtkWidget *         visu_ui_line_getOptionBox           (VisuUiLine *line);

Give access to the GtkVBox of the expander.

line :

the object to get the GtkVBox.

Returns :

a GtkWidget. [transfer none]

Since 3.6


visu_ui_line_new ()

GtkWidget *         visu_ui_line_new                    (const gchar *label);

A VisuUiLine widget is a widget allowing to choose the properties of a line. These properties are the line stipple pattern, its colour and its width. The colour is available through GtkRange and with a VisuUiColorCombobox widget. There is also a checkbox allowing to turn the line on or off.

label :

the name of the group, output in bold.

Returns :

a newly created VisuUiLine widget. [transfer full]

Since 3.4


visu_ui_line_setColor ()

void                visu_ui_line_setColor               (VisuUiLine *line,
                                                         float rgb[3]);

The line can is drawn in a given colour. Change the interface values using this routine. The colour ranges are updated and if it correspond to a registered colour, it is selected in the combobox.

line :

the object to modify ;

rgb :

a RGB array.

Since 3.4


visu_ui_line_setStipple ()

void                visu_ui_line_setStipple             (VisuUiLine *line,
                                                         guint16 stipple);

The line can be drawn with a given stipple pattern, call this routine to change the interface value.

line :

the object to modify ;

stipple :

a value.

Since 3.4


visu_ui_line_setUsed ()

void                visu_ui_line_setUsed                (VisuUiLine *line,
                                                         gboolean status);

The line can be turn on or off, call this routine to change the interface status.

line :

the object to modify ;

status :

a boolean.

Since 3.4


visu_ui_line_setWidth ()

void                visu_ui_line_setWidth               (VisuUiLine *line,
                                                         gint width);

The line can be drawn with a given width, call this routine to change the interface value.

line :

the object to modify ;

width :

a value.

Since 3.4

Signal Details

The "color-changed" signal

void                user_function                      (VisuUiLine *line,
                                                        gpointer    color,
                                                        gpointer    user_data)      : Action

This signal is emitted when the colour of the line is changed.

line :

the VisuUiLine that emits the signal ;

color :

the new color values (three RGB values).

user_data :

user data set when the signal handler was connected.

Since 3.4


The "stipple-changed" signal

void                user_function                      (VisuUiLine *line,
                                                        guint       stipple,
                                                        gpointer    user_data)      : Action

This signal is emitted when the stipple pattern of the line is changed.

line :

the VisuUiLine that emits the signal ;

stipple :

the new stipple pattern.

user_data :

user data set when the signal handler was connected.

Since 3.4


The "use-changed" signal

void                user_function                      (VisuUiLine *line,
                                                        gboolean    used,
                                                        gpointer    user_data)      : Action

This signal is emitted when the usage check box is changed.

line :

the VisuUiLine that emits the signal ;

used :

TRUE if the line is used.

user_data :

user data set when the signal handler was connected.

Since 3.4


The "width-changed" signal

void                user_function                      (VisuUiLine *line,
                                                        gint        width,
                                                        gpointer    user_data)      : Action

This signal is emitted when the width of the line is changed.

line :

the VisuUiLine that emits the signal ;

width :

the new width.

user_data :

user data set when the signal handler was connected.

Since 3.4

See Also

VisuUiColorCombobox and VisuUiStippleCombobox