Gladeui.Signal¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
class |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
Whether this signal is run after default handlers |
||
r/w/co |
The signal class of this signal |
||
r/w |
The detail for this signal |
||
r/w |
The handler for this signal |
||
r/w |
The versioning support warning for this signal |
||
r/w |
Whether the user data is swapped with the instance for the handler |
||
r/w |
The user data for this signal |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
object |
r |
Class Details¶
- class Gladeui.Signal(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
- classmethod new(sig_def, handler, userdata, after, swapped)¶
- Parameters:
sig_def (
Gladeui.SignalDef
) – aGladeui.SignalDef
handler (
str
) – a handler function for the signaluserdata (
str
) – the userdata for this signalafter (
bool
) – whether this handler should be called after the default emission phaseswapped (
bool
) – whether the handler’s user data should be swapped with the emitter instance.
- Returns:
the new
Gladeui.Signal
- Return type:
Creates a new
Gladeui.Signal
with the given parameters.
- classmethod read(node, adaptor)¶
- Parameters:
node (
Gladeui.XmlNode
) – TheGladeui.XmlNode
to readadaptor (
Gladeui.WidgetAdaptor
) – TheGladeui.WidgetAdaptor
for the widget
- Returns:
A newly created
Gladeui.Signal
- Return type:
Reads and creates a ner
Gladeui.Signal
based on node
- clone()¶
- Returns:
a new
Gladeui.Signal
with the same attributes as self- Return type:
- equal(sig2)¶
- Parameters:
sig2 (
Gladeui.Signal
) – aGladeui.Signal
- Returns:
True
if self and sig2 have identical attributes,False
otherwise- Return type:
- get_after()¶
- Returns:
Whether the signal handler should be called after the default handler
- Return type:
Get whether the handler should be called before or after the default handler of the signal.
- get_def()¶
- Returns:
- Return type:
Get the signal definition.
- get_name()¶
- Returns:
The name of the signal
- Return type:
Get the name of the signal from the signal definition.
- get_swapped()¶
- Returns:
whether the instance and userdata arguments should be swapped
- Return type:
Get whether the instance and userdata arguments should be swapped.
- set_after(after)¶
- Parameters:
after (
bool
) – if the signal handler should be called after the default handler
Set whether the handler should be called before or after the default handler of the signal.
- set_detail(detail)¶
- Parameters:
detail (
str
) – the detail of the signal
Set the detail of the signal.
- set_handler(handler)¶
- Parameters:
handler (
str
) – the handler of the signal
Set the handler of the signal.
- set_swapped(swapped)¶
- Parameters:
swapped (
bool
) – if the instance and userdata arguments should be swapped
Set whether the instance and userdata arguments should be swapped.
- set_userdata(userdata)¶
- Parameters:
userdata (
str
) – the userdata of the signal
Set the userdata of the signal.
- write(context, node)¶
- Parameters:
context (
Gladeui.XmlContext
) – AGladeui.XmlContext
node (
Gladeui.XmlNode
) – AGladeui.XmlNode
Writes self to node
Property Details¶
- Gladeui.Signal.props.after¶
-
Whether this signal is run after default handlers
- Gladeui.Signal.props.class_¶
- Name:
class
- Type:
- Default Value:
- Flags:
The signal class of this signal
- Gladeui.Signal.props.detail¶
-
The detail for this signal
- Gladeui.Signal.props.handler¶
-
The handler for this signal
- Gladeui.Signal.props.support_warning¶
-
The versioning support warning for this signal
- Gladeui.Signal.props.swapped¶
-
Whether the user data is swapped with the instance for the handler