![]() |
![]() |
![]() |
clutk Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
CtkActor; CtkActorClass; CtkActorPrivate; void ctk_actor_set_state (CtkActor *actor
,CtkActorState state
); CtkActorState ctk_actor_get_state (CtkActor *actor
); void ctk_actor_set_padding (CtkActor *actor
,CtkPadding *padding
); void ctk_actor_get_padding (CtkActor *actor
,CtkPadding *padding
); GtkTextDirection ctk_actor_get_default_direction (void
); void ctk_actor_set_default_direction (GtkTextDirection dir
); void ctk_actor_set_background (CtkActor *actor
,ClutterActor *bg
); ClutterActor * ctk_actor_get_background (CtkActor *actor
); void ctk_actor_set_background_for_state (CtkActor *actor
,CtkActorState state
,ClutterActor *bg
); ClutterActor * ctk_actor_get_background_for_state (CtkActor *actor
,CtkActorState state
); void ctk_actor_set_tooltip_text (CtkActor *actor
,const gchar *self
); const gchar * ctk_actor_get_tooltip_text (CtkActor *actor
); void ctk_actor_add_effect (CtkActor *actor
,CtkEffect *effect
); void ctk_actor_remove_effect (CtkActor *actor
,CtkEffect *effect
); void ctk_actor_remove_all_effects (CtkActor *actor
); GSList * ctk_actor_get_effects (CtkActor *actor
); void ctk_actor_set_effects_painting (CtkActor *actor
,gboolean painting
); gboolean ctk_actor_get_effects_painting (CtkActor *actor
); void ctk_actor_set_damaged (CtkActor *actor
,gboolean damaged
); gboolean ctk_actor_get_damaged (CtkActor *actor
); void ctk_actor_get_stored_allocation (CtkActor *actor
,ClutterActorBox *box
); void ctk_actor_recurse_get_stored_allocation_box (CtkActor *actor
,ClutterActorBox *box
);
GObject +----GInitiallyUnowned +----ClutterActor +----CtkActor +----CtkBin +----CtkBox +----CtkIconView +----CtkImage +----CtkLayerActor +----CtkMenu +----CtkTooltip
"background" gpointer : Read / Write "effects-painting" gboolean : Read / Write "focused" gboolean : Read / Write "padding" CtkPadding* : Read / Write "state" CtkActorState : Read / Write "tooltip-text" gchar* : Read / Write
"child-focus-changed" : Run Last "drag-begin" : Run Last "drag-data-delete" : Run Last "drag-data-get" : Run Last "drag-data-received" : Run Last "drag-drop" : Run Last "drag-end" : Run Last "drag-failed" : Run Last "drag-leave" : Run Last "drag-motion" : Run Last
A CtkActor is the base widget class for building Ctk style objects, it contains additional logic on top of ClutterActor for userinterface building
typedef struct { /* signals, not vfuncs */ void (*child_focus_changed) (CtkActor *actor, ClutterActorBox *box); void (*drag_leave) (CtkActor *actor, GdkDragContext *context, guint time_); void (*drag_begin) (CtkActor *actor, GdkDragContext *context); void (*drag_end) (CtkActor *actor, GdkDragContext *context); void (*drag_data_delete) (CtkActor *actor, GdkDragContext *context); void (*drag_failed) (CtkActor *actor, GdkDragContext *context, GtkDragResult result); void (*drag_motion) (CtkActor *actor, GdkDragContext *context, gint x, gint y, guint time_); void (*drag_drop) (CtkActor *actor, GdkDragContext *context, gint x, gint y, guint time_); void (*drag_data_get) (CtkActor *actor, GdkDragContext *context, GtkSelectionData *data, guint info, guint time_); void (*drag_data_received) (CtkActor *actor, GdkDragContext *context, gint x, gint y, GtkSelectionData *data, guint info, guint time_); /* vtable */ } CtkActorClass;
void ctk_actor_set_state (CtkActor *actor
,CtkActorState state
);
Sets the state of actor
!FIXME! flesh this out more
|
A CtkActor |
|
A CtkActorState |
CtkActorState ctk_actor_get_state (CtkActor *actor
);
gets the currently set CtkActorState for actor
|
A CtkActor |
Returns : |
a CtkActorState |
void ctk_actor_set_padding (CtkActor *actor
,CtkPadding *padding
);
Sets the padding of actor
to padding
|
A CtkActor |
|
A CtkPadding struct |
void ctk_actor_get_padding (CtkActor *actor
,CtkPadding *padding
);
Will return via padding
the padding values of actor
set by ctk_actor_set_padding()
|
A CtkActor |
|
a CtkPadding struct to be filled with the return value |
GtkTextDirection ctk_actor_get_default_direction (void
);
Returns the default direction for all CtkActor widgets
Returns : |
A GtkTextDirection object |
void ctk_actor_set_default_direction (GtkTextDirection dir
);
Sets the default direction for all CtkActor objects
|
A GtkTextDirection object |
void ctk_actor_set_background (CtkActor *actor
,ClutterActor *bg
);
Sets the background for actor
to bg
Will fade out old background first if one exists
|
CtkActor |
|
ClutterActor |
ClutterActor * ctk_actor_get_background (CtkActor *actor
);
Gets the current background for actor
as previously set by ctk_actor_set_background()
|
A CtkActor |
Returns : |
A ClutterActor |
void ctk_actor_set_background_for_state (CtkActor *actor
,CtkActorState state
,ClutterActor *bg
);
Sets the background of actor
for the given state
!FIXME! - needs fleshing out more
|
A CtkActor |
|
A CtkActorState |
|
A ClutterActor |
ClutterActor * ctk_actor_get_background_for_state (CtkActor *actor
,CtkActorState state
);
Gets the current background for actor
in the given state
previously set by ctk_actor_set_background_for_state()
|
A CtkActor |
|
A CtkActorState |
Returns : |
a ClutterActor |
void ctk_actor_set_tooltip_text (CtkActor *actor
,const gchar *self
);
Sets the tooltip for actor
to the contents of tooltip_text
|
A CtkActor |
|
a text string |
const gchar * ctk_actor_get_tooltip_text (CtkActor *actor
);
gets the tooltip text for actor
previously set by ctk_actor_set_tooltip_text()
|
a CtkActor |
Returns : |
a string defining the tooltip text |
void ctk_actor_add_effect (CtkActor *actor
,CtkEffect *effect
);
Adds effect
to the list of actor
's effects
void ctk_actor_remove_effect (CtkActor *actor
,CtkEffect *effect
);
Remove effect
from the list of effects attached to the actor
void ctk_actor_remove_all_effects (CtkActor *actor
);
Remove all effets from the list of effects attached to the actor
|
a CtkActor |
GSList * ctk_actor_get_effects (CtkActor *actor
);
|
a CtkActor |
Returns : |
a GSList of CtkEffects. Do not modify or free the returned list. |
void ctk_actor_set_effects_painting (CtkActor *actor
,gboolean painting
);
This function should be used by objects inheriting CtkActor, to stop parent
paint functions from also painting any CtkEffects attached to actor
.
In the same way, you should check for ctk_actor_get_effects_painting in your paint function before calling ctk_effect_paint.
gboolean ctk_actor_get_effects_painting (CtkActor *actor
);
|
a CtkActor |
Returns : |
whether actor is currently being painting by an CtkEffect. See
ctk_actor_set_effects_painting.
|
void ctk_actor_set_damaged (CtkActor *actor
,gboolean damaged
);
Sets the damaged value on actor
, if the damaged
is true then the actor
will bubble up to its parent CtkActor, but stop at a non CtkActor
|
A CtkActor |
|
A Boolean value dicatating the state of damage |
void ctk_actor_get_stored_allocation (CtkActor *actor
,ClutterActorBox *box
);
|
A CtkActor |
|
A ClutterAllocationBox. [out] |
"effects-painting"
property "effects-painting" gboolean : Read / Write
Whether effects are controlling painting.
Default value: FALSE
"focused"
property "focused" gboolean : Read / Write
Whether the actor is currently in focus.
Default value: FALSE
"state"
property"state" CtkActorState : Read / Write
The current state of the actor.
Default value: CTK_STATE_NORMAL
"child-focus-changed"
signalvoid user_function (CtkActor *ctkactor, ClutterActorBox *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"drag-begin"
signalvoid user_function (CtkActor *ctkactor, GdkDragContext *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"drag-data-delete"
signalvoid user_function (CtkActor *ctkactor, GdkDragContext *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"drag-data-get"
signalvoid user_function (CtkActor *ctkactor, GdkDragContext *arg1, GtkSelectionData *arg2, guint arg3, guint arg4, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
|
|
|
|
user data set when the signal handler was connected. |
"drag-data-received"
signalvoid user_function (CtkActor *ctkactor, GdkDragContext *arg1, gint arg2, gint arg3, GtkSelectionData *arg4, guint arg5, guint arg6, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
|
|
|
|
|
|
|
|
user data set when the signal handler was connected. |
"drag-drop"
signalgboolean user_function (CtkActor *ctkactor, GdkDragContext *arg1, gint arg2, gint arg3, guint arg4, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
|
|
|
|
user data set when the signal handler was connected. |
Returns : |
"drag-end"
signalvoid user_function (CtkActor *ctkactor, GdkDragContext *arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"drag-failed"
signalgboolean user_function (CtkActor *ctkactor, GdkDragContext *arg1, GtkDragResult arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |
Returns : |
"drag-leave"
signalvoid user_function (CtkActor *ctkactor, GdkDragContext *arg1, guint arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |
"drag-motion"
signalgboolean user_function (CtkActor *ctkactor, GdkDragContext *arg1, gint arg2, gint arg3, guint arg4, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
|
|
|
|
user data set when the signal handler was connected. |
Returns : |