VisuUiLine

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

Functions

Properties

ToolColor * color Read / Write
gchar * label Write / Construct

Signals

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkContainer
                ╰── GtkBox
                    ╰── VisuUiLine
                        ├── VisuUiAxes
                        ├── VisuUiBox
                        ╰── VisuUiScale

Implemented Interfaces

VisuUiLine implements AtkImplementorIface, GtkBuildable and GtkOrientable.

Description

Functions

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.

Parameters

label

the name of the group, output in bold.

 

Returns

a newly created VisuUiLine widget.

[transfer full]

Since: 3.4


visu_ui_line_bind ()

void
visu_ui_line_bind (VisuUiLine *line,
                   VisuGlExtLined *model);

Bind the properties of model to be displayed by line .

Parameters

line

a VisuUiLine object.

 

model

a VisuGlExtLined object.

[transfer none]

Since: 3.8


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.

Parameters

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.

Parameters

line

the object to modify ;

 

width

a value.

 

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.

Parameters

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.

Parameters

line

the object to modify ;

 

stipple

a value.

 

Since: 3.4


visu_ui_line_getOptionBox ()

GtkWidget *
visu_ui_line_getOptionBox (VisuUiLine *line);

Give access to the GtkVBox of the expander.

Parameters

line

the object to get the GtkVBox.

 

Returns

a GtkWidget.

[transfer none]

Since: 3.6

Types and Values

struct VisuUiLine

struct VisuUiLine;

Private structure to store informations of a VisuUiLine object.

Since: 3.4


struct VisuUiLineClass

struct VisuUiLineClass {
  GtkBoxClass parent_class;

  void (*lineObject) (VisuUiLine *box);
};

Private structure to store informations of a VisuUiLineClass object.

Members

lineObject ()

to be removed.

 

Since: 3.4


VisuUiLinePrivate

typedef struct _VisuUiLinePrivate VisuUiLinePrivate;

Private data.

Property Details

The “color” property

  “color”                    ToolColor *

selected color.

Flags: Read / Write


The “label” property

  “label”                    gchar *

displayed label on the expander.

Flags: Write / Construct

Default value: "parameters"

Signal Details

The “color-changed” signal

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

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

Parameters

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.

 

Flags: Action

Since: 3.4


The “stipple-changed” signal

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

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

Parameters

line

the VisuUiLine that emits the signal ;

 

stipple

the new stipple pattern.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 3.4


The “use-changed” signal

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

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

Parameters

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.

 

Flags: Action

Since: 3.4


The “width-changed” signal

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

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

Parameters

line

the VisuUiLine that emits the signal ;

 

width

the new width.

 

user_data

user data set when the signal handler was connected.

 

Flags: Action

Since: 3.4

See Also

VisuUiColorCombobox and VisuUiStippleCombobox