HudClientParam

HudClientParam — Track a parameterized view

Stability Level

Unstable, unless otherwise indicated

Functions

Signals

void model-ready Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── HudClientParam

Includes

#include <libhud-client/param.h>

Description

This makes it much easier to interact with the parameterized pane of the HUD. Provides the links to the menu model and the actions that should be shown. Also provides convienience functions for resetting it and fun stuff like that.

Functions

hud_client_param_new ()

HudClientParam *
hud_client_param_new (const gchar *dbus_address,
                      const gchar *prefix,
                      const gchar *base_action,
                      const gchar *action_path,
                      const gchar *model_path,
                      gint model_section);

Create a new HudClientParam object for adjusting a specified paramaterized dialog.

Parameters

dbus_address

The address on dbus to find the actions

 

prefix

The prefix the menu is using

 

base_action

The action to send events for the dialog on

 

action_path

DBus path to the action object

 

model_path

DBus path to the menu model object

 

model_section

Section of the model to use

 

Returns

A new HudClientParam dialog.

[transfer full]


hud_client_param_get_actions ()

GActionGroup *
hud_client_param_get_actions (HudClientParam *param);

The object path to the actions

Parameters

param

The HudClientParam to query

 

Returns

A GActionGroup that has the actions in it.

[transfer none]


hud_client_param_get_model ()

GMenuModel *
hud_client_param_get_model (HudClientParam *param);

The object path to the model

Parameters

param

The HudClientParam to query

 

Returns

The menu model of the pane.

[transfer none]


hud_client_param_send_reset ()

void
hud_client_param_send_reset (HudClientParam *param);

Send the command to the application to reset the values of the actions in the pane.

Parameters

param

The HudClientParam to query

 

hud_client_param_send_cancel ()

void
hud_client_param_send_cancel (HudClientParam *param);

Send the command to the application to cancel the values of the actions in the panel and expect it to close soon.

Parameters

param

The HudClientParam to query

 

hud_client_param_send_commit ()

void
hud_client_param_send_commit (HudClientParam *param);

Tell the application that the user has requested the values be applied. This doesn't mean that there isn't a dialog still open, when it closes "end" will be sent.

Parameters

param

The HudClientParam to query

 

Types and Values

HUD_CLIENT_PARAM_SIGNAL_MODEL_READY

#define HUD_CLIENT_PARAM_SIGNAL_MODEL_READY  "model-ready"

Signal to indicate when the model is ready


struct HudClientParamClass

struct HudClientParamClass {
	GObjectClass parent_class;

	/*< Private >*/
	void (*model_ready) (HudClientParamClass * param, gpointer user_data);
};

Class information for HudClientParam

Members

GObjectClass parent_class;

GObjectClass

 

model_ready ()

Slot for the model-ready signal

 

struct HudClientParam

struct HudClientParam;

An object that tracks all the of the stuff needed to handle a parameterized dialog of actions.


HudClientParamPrivate

typedef struct _HudClientParamPrivate HudClientParamPrivate;

Private data for HudClientParam.

Signal Details

The “model-ready” signal

void
user_function (HudClientParam *arg0,
               gpointer        user_data)

Emitted when the model can be used. It may also be updating, but the base item is there.

Parameters

arg0

The HudClientParam object.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last