AyatanaIdo3.ScaleMenuItem¶

Subclasses:: None

Methods¶

Inherited:: Gtk.MenuItem (20), Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.Actionable (5), Gtk.Activatable (6)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` (label, size, adjustment)
class	`new_from_model` (menuitem, actions)
class	`new_with_range` (label, size, value, min, max, step)
	`get_primary_image` ()
	`get_primary_label` ()
	`get_scale` ()
	`get_secondary_image` ()
	`get_secondary_label` ()
	`get_style` ()
	`primary_clicked` ()
	`secondary_clicked` ()
	`set_primary_label` (label)
	`set_secondary_label` (label)
	`set_style` (style)

Virtual Methods¶

Inherited:: Gtk.MenuItem (8), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.Actionable (4), Gtk.Activatable (2)

	`do_primary_clicked` ()
	`do_secondary_clicked` ()

Properties¶

Inherited:: Gtk.MenuItem (5), Gtk.Container (3), Gtk.Widget (39), Gtk.Actionable (2), Gtk.Activatable (2)

Name	Type	Flags	Short Description
`adjustment`	`Gtk.Adjustment`	r/w	The adjustment containing the scale value
`reverse-scroll-events`	`bool`	r/w	Reverses how up/down scroll events are interpreted

Style Properties¶

Inherited:: Gtk.MenuItem (6), Gtk.Widget (17)

Signals¶

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

Name	Short Description
`primary-clicked`	The `::primary-clicked` signal is emitted when the pointer clicks the primary label.
`secondary-clicked`	The `::secondary-clicked` signal is emitted when the pointer clicks the secondary label.
`slider-grabbed`	The `::slider-grabbed` signal is emitted when the pointer selects the slider.
`slider-released`	The `::slider-released` signal is emitted when the pointer releases the slider.
`value-changed`	Emitted whenever the value of the contained scale changes because of user input.

Fields¶

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

Name	Type	Access	Description
parent_instance	`Gtk.MenuItem`	r

Class Details¶

class AyatanaIdo3.ScaleMenuItem(*args, **kwargs)¶

Bases:: Gtk.MenuItem
Abstract:: No
Structure:: AyatanaIdo3.ScaleMenuItemClass

classmethod new(label, size, adjustment)¶

Parameters:

label (str) – the text of the new menu item.
size (AyatanaIdo3.RangeStyle) – The size style of the range.
adjustment (Gtk.Adjustment) – A Gtk.Adjustment describing the slider value.

Returns:

a new AyatanaIdo3.ScaleMenuItem.

Return type:

Gtk.Widget

Creates a new AyatanaIdo3.ScaleMenuItem with an empty label.

classmethod new_from_model(menuitem, actions)¶

Parameters:

menuitem (Gio.MenuItem) –
actions (Gio.ActionGroup) –

Returns:

a new AyatanaIdo3.ScaleMenuItem

Return type:

Gtk.MenuItem

Creates a new AyatanaIdo3.ScaleMenuItem. If menuitem contains an action, it will be bound to that action in actions.

classmethod new_with_range(label, size, value, min, max, step)¶

Parameters:

label (str) –
size (AyatanaIdo3.RangeStyle) –
value (float) –
min (float) –
max (float) –
step (float) –

Return type:

Gtk.Widget

get_primary_image()¶

Returns:: A Gtk.Widget pointer for the primary image.
Return type:: Gtk.Widget

Retrieves a pointer to the image widget used in the primary slot. Whether this is visible depends upon the return value from AyatanaIdo3.ScaleMenuItem.get_style().

get_primary_label()¶

Returns:: The label text.
Return type:: str

Retrieves a string of the text for the primary label widget. Whether this is visible depends upon the return value from AyatanaIdo3.ScaleMenuItem.get_style().

get_scale()¶

Returns:: The AyatanaIdo3.Range in this item
Return type:: Gtk.Widget

Retrieves the scale widget.

get_secondary_image()¶

Returns:: A Gtk.Widget pointer for the secondary image.
Return type:: Gtk.Widget

Retrieves a pointer to the image widget used in the secondary slot. Whether this is visible depends upon the return value from AyatanaIdo3.ScaleMenuItem.get_style().

get_secondary_label()¶

Returns:: The label text.
Return type:: str

Retrieves a string of the text for the secondary label widget. Whether this is visible depends upon the return value from AyatanaIdo3.ScaleMenuItem.get_style().

get_style()¶

Returns:: A AyatanaIdo3.ScaleMenuItemStyle enum describing the style.
Return type:: AyatanaIdo3.ScaleMenuItemStyle

Retrieves the type of widgets being used for the primary and secondary widget slots. This could be images, labels, or nothing.

primary_clicked()¶

Emits the “primary-clicked” signal.

The default handler for this signal lowers the scale’s adjustment to its lower bound.

secondary_clicked()¶

Emits the “secondary-clicked” signal.

The default handler for this signal raises the scale’s adjustment to its upper bound.

set_primary_label(label)¶

Parameters:: label (str) – The label text

Sets the text for the label widget in the primary slot. This widget will only be visibile if the return value of AyatanaIdo3.ScaleMenuItem.get_style() is set to AyatanaIdo3.ScaleMenuItemStyle.LABEL.

set_secondary_label(label)¶

Parameters:: label (str) – The label text

Sets the text for the label widget in the secondary slot. This widget will only be visibile if the return value of AyatanaIdo3.ScaleMenuItem.get_style() is set to AyatanaIdo3.ScaleMenuItemStyle.LABEL.

set_style(style)¶

Parameters:: style (AyatanaIdo3.ScaleMenuItemStyle) – Set the style use for the primary and secondary widget slots.

Sets the type of widgets being used for the primary and secondary widget slots. This could be images, labels, or nothing.

do_primary_clicked() virtual¶

Emits the “primary-clicked” signal.

The default handler for this signal lowers the scale’s adjustment to its lower bound.

do_secondary_clicked() virtual¶

Emits the “secondary-clicked” signal.

The default handler for this signal raises the scale’s adjustment to its upper bound.

Signal Details¶

AyatanaIdo3.ScaleMenuItem.signals.primary_clicked(scale_menu_item)¶

Signal Name:: primary-clicked
Flags:: RUN_FIRST, NO_RECURSE, NO_HOOKS
Parameters:: scale_menu_item (AyatanaIdo3.ScaleMenuItem) – The object which received the signal

The ::primary-clicked signal is emitted when the pointer clicks the primary label.

AyatanaIdo3.ScaleMenuItem.signals.secondary_clicked(scale_menu_item)¶

Signal Name:: secondary-clicked
Flags:: RUN_FIRST, NO_RECURSE, NO_HOOKS
Parameters:: scale_menu_item (AyatanaIdo3.ScaleMenuItem) – The object which received the signal

The ::secondary-clicked signal is emitted when the pointer clicks the secondary label.

AyatanaIdo3.ScaleMenuItem.signals.slider_grabbed(scale_menu_item)¶

Signal Name:: slider-grabbed
Flags:: RUN_FIRST
Parameters:: scale_menu_item (AyatanaIdo3.ScaleMenuItem) – The object which received the signal

The ::slider-grabbed signal is emitted when the pointer selects the slider.

AyatanaIdo3.ScaleMenuItem.signals.slider_released(scale_menu_item)¶

Signal Name:: slider-released
Flags:: RUN_FIRST
Parameters:: scale_menu_item (AyatanaIdo3.ScaleMenuItem) – The object which received the signal

The ::slider-released signal is emitted when the pointer releases the slider.

AyatanaIdo3.ScaleMenuItem.signals.value_changed(scale_menu_item, value)¶

Signal Name:

value-changed

Flags:

RUN_LAST

Parameters:

scale_menu_item (AyatanaIdo3.ScaleMenuItem) – The object which received the signal
value (float) – the new value

Emitted whenever the value of the contained scale changes because of user input.

Property Details¶

AyatanaIdo3.ScaleMenuItem.props.adjustment¶

Name:: adjustment
Type:: Gtk.Adjustment
Default Value:: None
Flags:: READABLE, WRITABLE

The adjustment containing the scale value

AyatanaIdo3.ScaleMenuItem.props.reverse_scroll_events¶

Name:: reverse-scroll-events
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

Reverses how up/down scroll events are interpreted