MexToolProvider

MexToolProvider — Interface for sources of tools

Synopsis

#define             MEX_TOOL_PROVIDER_IFACE             (iface)
#define             MEX_IS_TOOL_PROVIDER_IFACE          (iface)
enum                MexToolMode;
struct              MexToolProviderInterface;
const GList *       mex_tool_provider_get_tools         (MexToolProvider *provider);
const GList *       mex_tool_provider_get_bindings      (MexToolProvider *provider);
void                mex_tool_provider_set_tool_mode     (MexToolProvider *provider,
                                                         MexToolMode mode,
                                                         guint duration);
void                mex_tool_provider_present_actor     (MexToolProvider *provider,
                                                         ClutterActor *actor);
void                mex_tool_provider_remove_actor      (MexToolProvider *provider,
                                                         ClutterActor *actor);

Object Hierarchy

  GEnum
   +----MexToolMode

Description

Implementing MexToolProvider means that the class can provide a list of tools (focusable actors that provide some useful functionality).

Details

MEX_TOOL_PROVIDER_IFACE()

#define             MEX_TOOL_PROVIDER_IFACE(iface)

MEX_IS_TOOL_PROVIDER_IFACE()

#define             MEX_IS_TOOL_PROVIDER_IFACE(iface)

enum MexToolMode

typedef enum
{
  TOOL_MODE_FULL,
  TOOL_MODE_PIP, /* Picture in picture */
  TOOL_MODE_SBS /* Side-by-side */
} MexToolMode;

struct MexToolProviderInterface

struct MexToolProviderInterface {
  GTypeInterface g_iface;

  /* virtual functions */
  const GList * (*get_tools)    (MexToolProvider *provider);
  const GList * (*get_bindings) (MexToolProvider *provider);
  void          (*set_tool_mode) (MexToolProvider *provider,
                                  MexToolMode mode,
                                  guint duration);

  /* signals */
  void (* present_actor)       (MexToolProvider *provider,
                                ClutterActor    *actor);
  void (* remove_actor)         (MexToolProvider *provider,
                                ClutterActor     *actor);
};

mex_tool_provider_get_tools ()

const GList *       mex_tool_provider_get_tools         (MexToolProvider *provider);

Retrieves the list of tools from a MexToolProvider. This is a list of ClutterActor##s.

provider :

a MexToolProvider

Returns :

The tools of provider

mex_tool_provider_get_bindings ()

const GList *       mex_tool_provider_get_bindings      (MexToolProvider *provider);

Retrieves a list of key-bindings from a MexToolProvider. This is a list of MexToolProviderBinding##s. See clutter_binding_pool_install_action().

provider :

a MexToolProvider

Returns :

Key-bindings associated with provider

mex_tool_provider_set_tool_mode ()

void                mex_tool_provider_set_tool_mode     (MexToolProvider *provider,
                                                         MexToolMode mode,
                                                         guint duration);

mex_tool_provider_present_actor ()

void                mex_tool_provider_present_actor     (MexToolProvider *provider,
                                                         ClutterActor *actor);

mex_tool_provider_remove_actor ()

void                mex_tool_provider_remove_actor      (MexToolProvider *provider,
                                                         ClutterActor *actor);