InfcExploreRequest

InfcExploreRequest

Synopsis




                    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);

Object Hierarchy


  GObject
   +----InfcRequest
         +----InfcExploreRequest

Properties


  "current"                  guint                 : Read / Write
  "finished"                 gboolean              : Read
  "initiated"                gboolean              : Read
  "node-id"                  guint                 : Read / Write / Construct Only
  "total"                    guint                 : Read / Write

Signals


  "finished"                                       : Run Last
  "initiated"                                      : Run Last
  "progress"                                       : Run Last

Description

Details

InfcExploreRequest

typedef struct _InfcExploreRequest InfcExploreRequest;


InfcExploreRequestClass

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;


infc_explore_request_get_node_id ()

guint               infc_explore_request_get_node_id    (InfcExploreRequest *request);

Returns the ID of the node to be explored.

request :

An InfcExploreRequest.

Returns :

ID of the node to be explored.

infc_explore_request_initiated ()

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.

request :

An InfcExploreRequest.

total :


infc_explore_request_progress ()

gboolean            infc_explore_request_progress       (InfcExploreRequest *request,
                                                         GError **error);

Emits the "progress" signal on request.

request :

A InfcExploreRequest.

error :

Location to store error information.

Returns :

TRUE when the signal was emitted, FALSE on error.

infc_explore_request_finished ()

gboolean            infc_explore_request_finished       (InfcExploreRequest *request,
                                                         GError **error);

Emits the "finished" signal on request.

request :

A InfcExploreRequest.

error :

Location to store error information.

Returns :

TRUE when the signal was emitted, FALSE on error.

infc_explore_request_get_initiated ()

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.

request :

A InfcExploreRequest.

Returns :

Whether the exploration was initiated.

infc_explore_request_get_finished ()

gboolean            infc_explore_request_get_finished   (InfcExploreRequest *request);

Returns whether the exploration process has finished, i.e. the "finished" signal was emitted.

request :

A InfcExploreRequest.

Returns :

Whether the exploration has finished.

Property Details

The "current" property

  "current"                  guint                 : Read / Write

Node that has just been explored.

Default value: 0


The "finished" property

  "finished"                 gboolean              : Read

Whether the exploration process has finished.

Default value: FALSE


The "initiated" property

  "initiated"                gboolean              : Read

Whether the exploration process was already initiated.

Default value: FALSE


The "node-id" property

  "node-id"                  guint                 : Read / Write / Construct Only

ID of the node to explore.

Default value: 0


The "total" property

  "total"                    guint                 : Read / Write

Total number of nodes that are explored.

Default value: 0

Signal Details

The "finished" signal

void                user_function                      (InfcExploreRequest *infcexplorerequest,
                                                        gpointer            user_data)               : Run Last

infcexplorerequest :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "initiated" signal

void                user_function                      (InfcExploreRequest *infcexplorerequest,
                                                        guint               arg1,
                                                        gpointer            user_data)               : Run Last

infcexplorerequest :

the object which received the signal.

arg1 :

user_data :

user data set when the signal handler was connected.

The "progress" signal

void                user_function                      (InfcExploreRequest *infcexplorerequest,
                                                        guint               arg1,
                                                        guint               arg2,
                                                        gpointer            user_data)               : Run Last

infcexplorerequest :

the object which received the signal.

arg1 :

arg2 :

user_data :

user data set when the signal handler was connected.