| libinfinity-0.4 Reference Manual | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Properties | Signals | ||||
InfcExploreRequest;
InfcExploreRequestClass;
guint infc_explore_request_get_node_id (InfcExploreRequest *request);
void infc_explore_request_initiated (InfcExploreRequest *request,
guint total);
gboolean infc_explore_request_progress (InfcExploreRequest *request,
GError **error);
gboolean infc_explore_request_finished (InfcExploreRequest *request,
GError **error);
gboolean infc_explore_request_get_initiated (InfcExploreRequest *request);
gboolean infc_explore_request_get_finished (InfcExploreRequest *request);
"current" guint : Read / Write "finished" gboolean : Read "initiated" gboolean : Read "node-id" guint : Read / Write / Construct Only "total" guint : Read / Write
typedef struct {
InfcRequestClass parent_class;
/* Signals */
void (*initiated)(InfcExploreRequest *explore_request,
guint total);
void (*progress)(InfcExploreRequest* explore_request,
guint current,
guint total);
void (*finished)(InfcExploreRequest* explore_request);
} InfcExploreRequestClass;
guint infc_explore_request_get_node_id (InfcExploreRequest *request);
Returns the ID of the node to be explored.
|
An InfcExploreRequest. |
Returns : |
ID of the node to be explored. |
void infc_explore_request_initiated (InfcExploreRequest *request, guint total);
Emits the "initiated" signal on request. An explore request is considered
initiated as soon as the total amount of child nodes is known.
|
An InfcExploreRequest. |
|
The total number of children of the node which is being explored. |
gboolean infc_explore_request_progress (InfcExploreRequest *request, GError **error);
Emits the "progress" signal on request.
|
A InfcExploreRequest. |
|
Location to store error information. |
Returns : |
TRUE when the signal was emitted, FALSE on error.
|
gboolean infc_explore_request_finished (InfcExploreRequest *request, GError **error);
Emits the "finished" signal on request.
|
A InfcExploreRequest. |
|
Location to store error information. |
Returns : |
TRUE when the signal was emitted, FALSE on error.
|
gboolean infc_explore_request_get_initiated (InfcExploreRequest *request);
Returns whether the exploration process was already initiated, i.e. the total number of nodes to explore is known.
|
A InfcExploreRequest. |
Returns : |
Whether the exploration was initiated. |
gboolean infc_explore_request_get_finished (InfcExploreRequest *request);
Returns whether the exploration process has finished, i.e. the "finished" signal was emitted.
|
A InfcExploreRequest. |
Returns : |
Whether the exploration has finished. |
"current" property"current" guint : Read / Write
Node that has just been explored.
Default value: 0
"finished" property"finished" gboolean : Read
Whether the exploration process has finished.
Default value: FALSE
"initiated" property"initiated" gboolean : Read
Whether the exploration process was already initiated.
Default value: FALSE
"node-id" property"node-id" guint : Read / Write / Construct Only
ID of the node to explore.
Default value: 0
"total" property"total" guint : Read / Write
Total number of nodes that are explored.
Default value: 0
"finished" signalvoid user_function (InfcExploreRequest *infcexplorerequest, gpointer user_data) : Run Last
|
the object which received the signal. |
|
user data set when the signal handler was connected. |
"initiated" signalvoid user_function (InfcExploreRequest *infcexplorerequest, guint arg1, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
user data set when the signal handler was connected. |
"progress" signalvoid user_function (InfcExploreRequest *infcexplorerequest, guint arg1, guint arg2, gpointer user_data) : Run Last
|
the object which received the signal. |
|
|
|
|
|
user data set when the signal handler was connected. |