GimpUi.IntRadioFrame¶

Subclasses:: None

Methods¶

Inherited:: GimpUi.Frame (1), Gtk.Frame (9), Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` (labels)
class	`new_from_store` (title, store)
	`get_active` ()
	`get_active_user_data` ()
	`set_active` (value)
	`set_active_by_user_data` (user_data)
	`set_sensitivity` (func, *data)
	`set_title` (title, with_mnemonic)

Virtual Methods¶

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

Properties¶

Inherited:: Gtk.Frame (5), Gtk.Container (3), Gtk.Widget (39)

Name	Type	Flags	Short Description
`store`	`GimpUi.IntStore`	r/w/en	The int store for the radio frame
`value`	`int`	r/w/en	Value of active item

Style Properties¶

Inherited:: GimpUi.Frame (2), Gtk.Widget (17)

Signals¶

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

Fields¶

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

Class Details¶

class GimpUi.IntRadioFrame(**kwargs)¶

Bases:: GimpUi.Frame
Abstract:: No
Structure:: GimpUi.IntRadioFrameClass

A widget providing a frame with title, containing grouped radio buttons, each associated with an integer value and random user data.

classmethod new(labels)¶

Parameters:: labels ([str]) – a None-terminated array of labels.
Returns:: a new GimpUi.IntRadioFrame.
Return type:: Gtk.Widget

A variant of GimpUi.IntRadioFrame.new() that takes an array of labels. The array indices are used as values.

New in version 3.0.

classmethod new_from_store(title, store)¶

Parameters:

title (str) – the frame label.
store (GimpUi.IntStore) – the GimpUi.IntStore to generate radio buttons from.

Returns:

a new GimpUi.IntRadioFrame.

Return type:

Gtk.Widget

Creates a GimpUi.IntRadioFrame containing radio buttons for each item in the store. The created widget takes ownership of store.

If you need to construct an empty GimpUi.IntRadioFrame, it’s best to use g_object_new (GIMP_TYPE_INT_RADIO_FRAME, None).

If you want to have a frame title with a mnemonic, set title to None instead and call [method`IntRadioFrame`.set_title] instead.

New in version 3.0.

get_active()¶

Returns:: the value of the active item.
Return type:: int

New in version 3.0.

get_active_user_data()¶

Returns:

True if user_data has been set or False if no item was active.

user_data:: return location for the object value

Return type:

(bool, user_data: object)

Retrieves the user-data of the selected (active) item in the self.

New in version 3.0.

set_active(value)¶

Parameters:: value (int) – an integer value
Returns:: True on success (value changed or not) or False if there was no item for this value.
Return type:: bool

Looks up the item that belongs to the given value and makes it the selected item in the self.

New in version 3.0.

set_active_by_user_data(user_data)¶

Parameters:: user_data (object or None) – an integer value
Returns:: True on success or False if there was no item for this user-data.
Return type:: bool

Looks up the item that has the given user_data and makes it the selected item in the self.

New in version 3.0.

set_sensitivity(func, *data)¶

Parameters:

func (GimpUi.IntRadioFrameSensitivityFunc) – a function that returns a boolean value, or None to unset
data (object or None) – data to pass to func

Sets a function that is used to decide about the sensitivity of radio buttons in the self. Use this if you want to set certain radio buttons insensitive.

Calling Gtk.Widget.queue_draw() on the self will cause the sensitivity to be updated.

New in version 3.0.

set_title(title, with_mnemonic)¶

Parameters:

title (str) – the frame title or None for none.
with_mnemonic (bool) – whether title has a mnemonic.

Change the self's title, possibly with a mnemonic.

New in version 3.0.

Property Details¶

GimpUi.IntRadioFrame.props.store¶

Name:: store
Type:: GimpUi.IntStore
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The GimpUi.IntStore from which the radio frame takes the values shown in the list.

New in version 3.0.

GimpUi.IntRadioFrame.props.value¶

Name:: value
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The active value

New in version 3.0.