v_sim.UiLine¶

Subclasses:: v_sim.UiAxes, v_sim.UiBox, v_sim.UiScale

Methods¶

Inherited:: Gtk.Box (14), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Orientable (2)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` (label)
	`bind` (model)
	`getOptionBox` ()
	`setColor` (rgb)
	`setStipple` (stipple)
	`setUsed` (status)
	`setWidth` (width)

Virtual Methods¶

Inherited:: Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

do_lineObject ()

Properties¶

Inherited:: Gtk.Box (3), Gtk.Container (3), Gtk.Widget (39), Gtk.Orientable (1)

Name	Type	Flags	Short Description
`color`	`v_sim.Color`	r/w	selected color
`label`	`str`	w/c	displayed label on the expander

Child Properties¶

Inherited:: Gtk.Box (5)

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Short Description
`color-changed`	This signal is emitted when the colour of the line is changed.
`stipple-changed`	This signal is emitted when the stipple pattern of the line is changed.
`use-changed`	This signal is emitted when the usage check box is changed.
`width-changed`	This signal is emitted when the width of the line is changed.

Fields¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
box	`Gtk.Box`	r
priv	`v_sim.UiLinePrivate`	r

Class Details¶

class v_sim.UiLine(*args, **kwargs)¶

Bases:: Gtk.Box
Abstract:: No
Structure:: v_sim.UiLineClass

Private structure to store informations of a v_sim.UiLine object.

New in version 3.4.

classmethod new(label)¶

Parameters:: label (str) – the name of the group, output in bold.
Returns:: a newly created v_sim.UiLine widget.
Return type:: Gtk.Widget

A v_sim.UiLine 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 Gtk.Range and with a v_sim.UiColorCombobox widget. There is also a checkbox allowing to turn the line on or off.

New in version 3.4.

bind(model)¶

Parameters:: model (v_sim.GlExtLined) – a v_sim.GlExtLined object.

Bind the properties of model to be displayed by self.

New in version 3.8.

getOptionBox()¶

Returns:: a Gtk.Widget.
Return type:: Gtk.Widget

Give access to the Gtk.VBox of the expander.

New in version 3.6.

setColor(rgb)¶

Parameters:: rgb (float) – a RGB array.

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.

New in version 3.4.

setStipple(stipple)¶

Parameters:: stipple (int) – a value.

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

New in version 3.4.

setUsed(status)¶

Parameters:: status (bool) – a boolean.

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

New in version 3.4.

setWidth(width)¶

Parameters:: width (int) – a value.

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

New in version 3.4.

do_lineObject() virtual¶: to be removed.

Signal Details¶

v_sim.UiLine.signals.color_changed(ui_line, color)¶

Signal Name:

color-changed

Flags:

RUN_FIRST, ACTION

Parameters:

ui_line (v_sim.UiLine) – The object which received the signal
color (object or None) – the new color values (three RGB values).

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

New in version 3.4.

v_sim.UiLine.signals.stipple_changed(ui_line, stipple)¶

Signal Name:

stipple-changed

Flags:

RUN_FIRST, ACTION

Parameters:

ui_line (v_sim.UiLine) – The object which received the signal
stipple (int) – the new stipple pattern.

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

New in version 3.4.

v_sim.UiLine.signals.use_changed(ui_line, used)¶

Signal Name:

use-changed

Flags:

RUN_FIRST, ACTION

Parameters:

ui_line (v_sim.UiLine) – The object which received the signal
used (bool) – True if the line is used.

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

New in version 3.4.

v_sim.UiLine.signals.width_changed(ui_line, width)¶

Signal Name:

width-changed

Flags:

RUN_FIRST, ACTION

Parameters:

ui_line (v_sim.UiLine) – The object which received the signal
width (int) – the new width.

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

New in version 3.4.

Property Details¶

v_sim.UiLine.props.color¶

Name:: color
Type:: v_sim.Color
Default Value:: None
Flags:: READABLE, WRITABLE

selected color

v_sim.UiLine.props.label¶

Name:: label
Type:: str
Default Value:: 'parameters'
Flags:: WRITABLE, CONSTRUCT

displayed label on the expander