Cally.Stage
Description: Reference for Cally.Stage

### Class

# CallyStage

since: 13

#### Description [src]

    class Cally.Stage : Cally.Actor
      implements Atk.Action, Atk.Component, Atk.Window {
      /* No available fields */
    }

Implementation of the ATK interfaces for a `ClutterStage`

`CallyStage` implements the required ATK interfaces for `ClutterStage`

Some implementation details: at this moment `CallyStage` is used as the most similar Window object in this toolkit (ie: emitting window related signals), although the real purpose of `ClutterStage` is being a canvas. Anyway, this is required for applications using just clutter, or directly `ClutterStage`

Available since: 13

#### Ancestors

- CallyActor
- AtkGObjectAccessible
- AtkObject
- GObject

#### Implements

- AtkAction
- AtkComponent
- AtkWindow

#### Constructors

###### cally_stage_new

Creates a new `CallyStage` for the given `actor`. `actor` should be a `ClutterStage`.

since: 13

#### Instance methods

##### Methods inherited from CallyActor (4)

###### cally_actor_add_action

Adds a new action to be accessed with the `AtkAction` interface.

since: 13

###### cally_actor_add_action_full

Adds a new action to be accessed with the `AtkAction` interface.

since: 13

###### cally_actor_remove_action

Removes a action, using the `action_id` returned by `cally_actor_add_action()`

since: 13

###### cally_actor_remove_action_by_name

Removes an action, using the `action_name` used when the action was added with `cally_actor_add_action()`

since: 13

##### Methods inherited from AtkGObjectAccessible (1)

###### atk_gobject_accessible_get_object

Gets the GObject for which `obj` is the accessible object.

since: 1.0

##### Methods inherited from AtkObject (26)

Please see AtkObject for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from AtkAction (7)

###### atk_action_do_action

Perform the specified action on the object.

since: 1.0

###### atk_action_get_description

Returns a description of the specified action of the object.

since: 1.0

###### atk_action_get_keybinding

Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format “mnemonic;sequence;shortcut”.

since: 1.0

###### atk_action_get_localized_name

Returns the localized name of the specified action of the object.

since: 1.0

###### atk_action_get_n_actions

Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the “default” action of the object.

since: 1.0

###### atk_action_get_name

Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the ‘interaction type’ which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. “click”, “press”, “release”, “drag”, “drop”, “popup”, etc. The “popup” action should be used to pop up a context menu for the object, if one exists.

since: 1.0

###### atk_action_set_description

Sets a description of the specified action of the object.

since: 1.0

##### Methods inherited from AtkComponent (16)

###### atk_component_add_focus_handler

Add the specified handler to the set of functions to be called when this object receives focus events (in or out). If the handler is already added it is not added again.

deprecated: 2.9.4 since: 1.0

###### atk_component_contains

Checks whether the specified point is within the extent of the `component`.

since: 1.0

###### atk_component_get_alpha

Returns the alpha value (i.e. the opacity) for this `component`, on a scale from 0 (fully transparent) to 1.0 (fully opaque).

since: 1.12

###### atk_component_get_extents

Gets the rectangle which gives the extent of the `component`.

since: 1.0

###### atk_component_get_layer

Gets the layer of the component.

since: 1.0

###### atk_component_get_mdi_zorder

Gets the zorder of the component. The value G_MININT will be returned if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.

since: 1.0

###### atk_component_get_position

Gets the position of `component` in the form of a point specifying `component`‘s top-left corner.

deprecated: Unknown since: 1.0

###### atk_component_get_size

Gets the size of the `component` in terms of width and height.

deprecated: Unknown since: 1.0

###### atk_component_grab_focus

Grabs focus for this `component`.

since: 1.0

###### atk_component_ref_accessible_at_point

Gets a reference to the accessible child, if one exists, at the coordinate point specified by `x` and `y`.

since: 1.0

###### atk_component_remove_focus_handler

Remove the handler specified by `handler_id` from the list of functions to be executed when this object receives focus events (in or out).

deprecated: 2.9.4 since: 1.0

###### atk_component_scroll_to

Makes `component` visible on the screen by scrolling all necessary parents.

since: 2.30

###### atk_component_scroll_to_point

Move the top-left of `component` to a given position of the screen by scrolling all necessary parents.

since: 2.30

###### atk_component_set_extents

Sets the extents of `component`.

since: 1.0

###### atk_component_set_position

Sets the position of `component`.

since: 1.0

###### atk_component_set_size

Set the size of the `component` in terms of width and height.

since: 1.0

#### Properties

##### Properties inherited from AtkObject (15)

###### Atk.Object:accessible-component-layer

No description available.

since: 1.0

###### Atk.Object:accessible-component-mdi-zorder

No description available.

since: 1.0

###### Atk.Object:accessible-description

No description available.

since: 1.0

###### Atk.Object:accessible-hypertext-nlinks

No description available.

since: 1.0

###### Atk.Object:accessible-name

No description available.

since: 1.0

###### Atk.Object:accessible-parent

No description available.

since: 1.0

###### Atk.Object:accessible-role

No description available.

since: 1.0

###### Atk.Object:accessible-table-caption

Table caption.

deprecated: Unknown since: 1.0

###### Atk.Object:accessible-table-caption-object

No description available.

since: 1.0

###### Atk.Object:accessible-table-column-description

Accessible table column description.

deprecated: Unknown since: 1.0

###### Atk.Object:accessible-table-column-header

Accessible table column header.

deprecated: Unknown since: 1.0

###### Atk.Object:accessible-table-row-description

Accessible table row description.

deprecated: Unknown since: 1.0

###### Atk.Object:accessible-table-row-header

Accessible table row header.

deprecated: Unknown since: 1.0

###### Atk.Object:accessible-table-summary

No description available.

since: 1.0

###### Atk.Object:accessible-value

Numeric value of this object, in case being and AtkValue.

deprecated: Unknown since: 1.0

#### Signals

##### Signals inherited from AtkObject (8)

###### AtkObject::active-descendant-changed

The “active-descendant-changed” signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.

since: 1.0

###### AtkObject::announcement

The “announcement” signal can be emitted to pass an announcement on to be read by a screen reader.

since: 2.46

###### AtkObject::children-changed

The signal “children-changed” is emitted when a child is added or removed form an object. It supports two details: “add” and “remove”

since: 1.0

###### AtkObject::focus-event

The signal “focus-event” is emitted when an object gained or lost focus.

deprecated: 2.9.4 since: 1.0

###### AtkObject::notification

The “notification” signal can be emitted to pass an announcement on to be read by a screen reader.

since: 2.50

###### AtkObject::property-change

The signal “property-change” is emitted when an object’s property value changes. `arg1` contains an `AtkPropertyValues` with the name and the new value of the property whose value has changed. Note that, as with GObject notify, getting this signal does not guarantee that the value of the property has actually changed; it may also be emitted when the setter of the property is called to reinstate the previous value.

since: 1.0

###### AtkObject::state-change

The “state-change” signal is emitted when an object’s state changes. The detail value identifies the state type which has changed.

since: 1.0

###### AtkObject::visible-data-changed

The “visible-data-changed” signal is emitted when the visual appearance of the object changed.

since: 1.0

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

since: 2.0

##### Signals inherited from AtkComponent (1)

###### AtkComponent::bounds-changed

The ‘bounds-changed” signal is emitted when the bposition or size of the component changes.

since: 1.0

##### Signals inherited from AtkWindow (9)

###### AtkWindow::activate

The signal `AtkWindow::activate` is emitted when a window becomes the active window of the application or session.

since: 2.2

###### AtkWindow::create

The signal `AtkWindow::create` is emitted when a new window is created.

since: 2.2

###### AtkWindow::deactivate

The signal `AtkWindow::deactivate` is emitted when a window is no longer the active window of the application or session.

since: 2.2

###### AtkWindow::destroy

The signal `AtkWindow::destroy` is emitted when a window is destroyed.

since: 2.2

###### AtkWindow::maximize

The signal `AtkWindow::maximize` is emitted when a window is maximized.

since: 2.2

###### AtkWindow::minimize

The signal `AtkWindow::minimize` is emitted when a window is minimized.

since: 2.2

###### AtkWindow::move

The signal `AtkWindow::move` is emitted when a window is moved.

since: 2.2

###### AtkWindow::resize

The signal `AtkWindow::resize` is emitted when a window is resized.

since: 2.2

###### AtkWindow::restore

The signal `AtkWindow::restore` is emitted when a window is restored.

since: 2.2

#### Class structure

    struct CallyStageClass {
      /* no available fields */
    }

The CallyStageClass structure contains only private data.