clutter.Actor

clutter.Actor — Base abstract class for all visual stage actors.

Synopsis

class clutter.Actor(gobject.GInitiallyUnowned):
    def show()

Ancestry

gobject.GObject
 +--gobject.GInitiallyUnowned
     +--clutter.Actor
  

Properties

"clip"Read-WriteThe clip region for the actor.
"depth"Read-WriteDepth of the actor. Default value: 0. Since 0.6.
"has-clip"ReadWhether the actor has the clip property set or not. Allowed values: >= -2147483647. Default value: False.
"height"Read-WriteHeight of the actor (in pixels). Allowed values: >= 0. Default value: 0.
"name"Read-WriteThe name of the actor. Default value: None. Since 0.2.
"opacity"Read-WriteOpacity of the actor. Default value: 255.
"reactive"Read-WriteWhether the actor is reactive or not. Default value: False. Since 0.6.
"rotation-angle-x"Read-WriteThe rotation angle on the X axis. Allowed values: >= 0. Default value: 0.
"rotation-angle-y"Read-WriteThe rotation angle on the Y axis. Allowed values: >= 0. Default value: 0.
"rotation-angle-z"Read-WriteThe rotation angle on the Z axis. Allowed values: >= 0. Default value: 0.
"rotation-center-x"Read-WriteThe rotation center on the X axis.
"rotation-center-y"Read-WriteThe rotation center on the Y axis.
"rotation-center-z"Read-WriteThe rotation center on the Z axis.
"scale-x"Read-WriteScale X. Allowed values: >= 0. Default value: 1.
"scale-y"Read-WriteScale Y. Allowed values: >= 0. Default value: 1.
"scale-z"Read-WriteScale Z. Allowed values: >= 0. Default value: 1.
"visible"Read-WriteWhether the actor is visible or not. Default value: False.
"width"Read-WriteWidth of the actor (in pixels). Allowed values: >= 0. Default value: 0.
"x"Read-WriteX coordinate of the actor. Allowed values: >= -2147483647. Default value: 0.
"y"Read-WriteY coordinate of the actor. Allowed values: >= -2147483647. Default value: 0.

Signal Prototypes

"button-press-event" def callback(actor, event, user_param1, ...)
"button-release-event" def callback(actor, event, user_param1, ...)
"captured-event" def callback(actor, event, user_param1, ...)
"destroy" def callback(actor, user_param1, ...)
"enter-event" def callback(actor, event, user_param1, ...)
"event" def callback(actor, event, user_param1, ...)
"focus-in" def callback(actor, user_param1, ...)
"focus-out" def callback(actor, user_param1, ...)
"hide" def callback(actor, user_param1, ...)
"key-press-event" def callback(actor, event, user_param1, ...)
"key-release-event" def callback(actor, event, user_param1, ...)
"leave-event" def callback(actor, event, user_param1, ...)
"motion-event" def callback(actor, event, user_param1, ...)
"parent-set" def callback(actor, old_parent, user_param1, ...)
"scroll-event" def callback(actor, event, user_param1, ...)
"show" def callback(actor, user_param1, ...)

Description

clutter.Actor is a base abstract class for all visual elements on the stage. Every object that must appear on the main clutter.Stage must also be a clutter.Actor, either by using one of the classes provided by Clutter, or by implementing a new clutter.Actor subclass.

Methods

clutter.Actor.show

    def show()

Flags a clutter actor to be displayed. An actor not shown will not appear on the display.

clutter.Actor.show_all

    def show_all()

Flags a clutter actor to be displayed, along with all its children. Whether or not show_all recurses it's an implementation detail of the actor itself.

clutter.Actor.hide

    def hide()

Flags a visible clutter actor to be hidden.

clutter.Actor.hide_all

    def hide_all()

Flags a visible clutter actor to be hidden, along with all its children.

Signals

The "button-press-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the object which received the event
event : a clutter.ButtonEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "button-press-event" signal is emitted each time a mouse button is pressed on actor.

The "button-release-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the object which received the event
event : a clutter.ButtonEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "button-release-event" signal is emitted each time a mouse button is released on actor.

The "captured-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the object which received the signal
event : a clutter.Event
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "captured-event" signal is emitted when an event is captured by Clutter. This signal will be emitted starting from the top-level container (the clutter.Stage) to the actor which received the event going down the hierarchy. This signal can be used to intercept every event before the specialized events (like "button-press-event" or "key-released-event") are emitted.

The "destroy" clutter.Actor signal

    def callback(actor, user_param1, ...)
actor : the object which received the signal
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "destroy" signal is emitted when an actor is destroyed, either by direct invocation of clutter.Actor.destroy() or when the clutter.Group that contains the actor is destroyed.

The "enter-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the object which the pointer has entered
event : a clutter.CrossingEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)
Returns : True if the event has been handled by the actor, or False to continue the emission.

The "event-event" signal is emitted when the pointer enters the actor.

The "event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the object which received the event
event : a clutter.Event
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)
Returns : True if the event has been handled by the actor, or False to continue the emission.

The "event" signal is emitted each time an event is received by the actor. This signal will be emitted on every actor, following the hierarchy chain, until it reaches the top-level container (the clutter.Stage).

The "focus-in" clutter.Actor signal

    def callback(actor, user_param1, ...)
actor : the actor which now now has key focus
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "focus-in" signal is emitted when actor recieves key focus.

The "focus-out" clutter.Actor signal

    def callback(actor, user_param1, ...)
actor : the actor which now now has key focus
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "focus-out" signal is emitted when actor loses key focus.

The "hide" clutter.Actor signal

    def callback(actor, user_param1, ...)
actor : the object which received the signal
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "hide" signal is emitted when an actor is no longer visible.

The "key-press-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the actor which received the event
event : a clutter.KeyEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)
Returns : True if the event has been handled by the actor, or False to continue the emission.

The "key-press-event" signal is emitted each time a keyboard button is pressed on actor.

The "key-release-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the actor which received the event
event : a clutter.KeyEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)
Returns : True if the event has been handled by the actor, or False to continue the emission.

The "key-press-event" signal is emitted each time a keyboard button is released on actor.

The "leave-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the actor which the pointer has left
event : a clutter.CrossingEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)
Returns : True if the event has been handled by the actor, or False to continue the emission.

The "leave-event" signal is emitted when the pointer leaves the actor.

The "motion-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the actor which the pointer has moved on
event : a clutter.MotionEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)
Returns : True if the event has been handled by the actor, or False to continue the emission.

The "motion-event" signal is emitted each time the mouse pointer is moved on actor.

The "parent-set" clutter.Actor signal

    def callback(actor, old_parent, user_param1, ...)
actor : the actor which received the signal
old_parent : the previous parent of the actor, or None
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "parent-set" signal is emitted when the parent of the actor changes.

The "scroll-event" clutter.Actor signal

    def callback(actor, event, user_param1, ...)
actor : the actor which received the event
event : a clutter.ScrollEvent
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)
Returns : True if the event has been handled by the actor, or False to continue the emission.

The "scroll-event" signal is emitted each time the mouse is scrolled on actor.

The "show" clutter.Actor signal

    def callback(actor, user_param1, ...)
actor : the actor which received the event
user_param1 : the first user parameter (if any) specified with the connect() method
... : additional user parameters (if any)

The "show" signal is emitted when an actor becomes visible.