MxFocusManager

MxFocusManager

Functions

Properties

Types and Values

Object Hierarchy

    GObject
    ╰── MxFocusManager

Description

Functions

mx_focus_manager_get_for_stage ()

MxFocusManager *
mx_focus_manager_get_for_stage (ClutterStage *stage);

Get the MxFocusManager associated with a stage, or create one if none exist for the specified stage.

Parameters

stage

A ClutterStage

 

Returns

An MxFocusManager.

[transfer none]


mx_focus_manager_get_stage ()

ClutterStage *
mx_focus_manager_get_stage (MxFocusManager *manager);

Get the stage the MxFocusManager is associated with

Parameters

manager

A MxFocusManager

 

Returns

A ClutterStage.

[transfer none]


mx_focus_manager_get_focused ()

MxFocusable *
mx_focus_manager_get_focused (MxFocusManager *manager);

Get the currently focused MxFocusable

Parameters

manager

A MxFocusManager

 

Returns

MxFocusable.

[transfer none]


mx_focus_manager_push_focus ()

void
mx_focus_manager_push_focus (MxFocusManager *manager,
                             MxFocusable *focusable);

Sets the currently focused actor, with an MxFocusHint of MX_FOCUS_HINT_PRIOR.

Note: the final focused object may not be the same as focusable if focusable does not accept focus directly.

Parameters

manager

the focus manager

 

focusable

the object to set focus on

 

mx_focus_manager_push_focus_with_hint ()

void
mx_focus_manager_push_focus_with_hint (MxFocusManager *manager,
                                       MxFocusable *focusable,
                                       MxFocusHint hint);

Similar to mx_focus_manager_push_focus, but allows the hint to be specified.

Note: the final focused object may not be the same as focusable if focusable does not accept focus directly.

Parameters

manager

the focus manager

 

focusable

the object to set focus on

 

hint

an MxFocusHint

 

Since: 1.2


mx_focus_manager_move_focus ()

void
mx_focus_manager_move_focus (MxFocusManager *manager,
                             MxFocusDirection direction);

Moves the current focus in the given direction.

Parameters

manager

the focus manager

 

direction

The direction to move focus in

 

Types and Values

struct MxFocusManager

struct MxFocusManager;

The contents of this structure are private and should only be accessed through the public API.


struct MxFocusManagerClass

struct MxFocusManagerClass {
  GObjectClass parent_class;

  /* padding for future expansion */
  void (*_padding_0) (void);
  void (*_padding_1) (void);
  void (*_padding_2) (void);
  void (*_padding_3) (void);
  void (*_padding_4) (void);
};

Property Details

The “focused” property

  “focused”                  ClutterActor *

The object that currently has focus.

Flags: Read


The “stage” property

  “stage”                    ClutterStage *

Top level container for focusables.

Flags: Read