gwy.SensitivityGroup

Module gwy :: Class SensitivityGroup

[show private | hide private]

Class SensitivityGroup

Method Summary
	`__init__()` Creates a new flag-based widget sensitivity group.
	`add_widget(widget, mask)` Adds a widget to flag sensitivity group.
	`get_state()` Gets the current state of a widget flag sensitivity group.
	`get_widget_mask(widget)` Gets sensitivity flags of a widget in a flag sensitivity group.
	`release_widget(widget)` Removes a widget from flag sensitivity group.
	`set_state(affected_mask, state)` Sets the state of a widget flag sensitivity group.
	`set_widget_mask(widget, mask)` Sets the flag mask of a widget in a flag sensitivity group.

Method Details

init()
(Constructor)

Creates a new flag-based widget sensitivity group.

Returns:: The newly created sensitivity group. It starts with zero state.

add_widget(widget, mask)

Adds a widget to flag sensitivity group.

Widget sensitivity should not be set manually after the addition as the result is likely to be a fight over sensitivity setting.

The added widget takes a reference on sensgroup. So the group is not destroyed when they are any widgets in, generally, you can release your initial reference after adding widgets to the group.

Parameters:: widget - Widget to add to sensgroup. (gtk.Widget); mask - Which flags the widget is sensitive to. See SensitivityGroup.set_state() for details. (int)

get_state()

Gets the current state of a widget flag sensitivity group.

Returns:: The current state as set with SensitivityGroup.set_state().

get_widget_mask(widget)

Gets sensitivity flags of a widget in a flag sensitivity group.

Parameters:: widget - Widget to get flags of. (gtk.Widget)

Returns:: The mask as passed to SensitivityGroup.add_widget() or SensitivityGroup.set_widget_mask().

release_widget(widget)

Removes a widget from flag sensitivity group.

Parameters:: widget - Widget to remove from sensgroup. (gtk.Widget)

set_state(affected_mask, state)

Sets the state of a widget flag sensitivity group.

Widget sensitivity states are then updated accordingly.

More precisely, widget will be made sensitive when all bits in its mask are set in current sensgroup state, insensitive otherwise. This means when mask is zero, widget will be always sensitive.

Parameters:: affected_mask - Which bits in state to copy to sensgroup state. 1's in affected_mask causes corresponding bits in sensgroup state to be set to the value of corresponding bit in state. 0's in affected_mask cause corresponding state bits to be kept on their current value. (int); state - The new state of sensgroup (masked with affected_mask). (int)

set_widget_mask(widget, mask)

Sets the flag mask of a widget in a flag sensitivity group.

Parameters:: widget - Widget to set flags of. (gtk.Widget); mask - Which flags the widget is sensitive to. See SensitivityGroup.set_state() for details. (int)

Generated by Epydoc 2.1 on Tue Dec 30 04:01:41 2008

http://epydoc.sf.net