BeagleQuery

BeagleQuery

Synopsis

enum                BeagleQueryDomain;
struct              BeagleQuery;
BeagleQuery *       beagle_query_new                    (void);
void                beagle_query_add_part               (BeagleQuery *query,
                                                         BeagleQueryPart *part);
void                beagle_query_add_text               (BeagleQuery *query,
                                                         const char *str);
void                beagle_query_set_domain             (BeagleQuery *query,
                                                         BeagleQueryDomain domain);
void                beagle_query_add_domain             (BeagleQuery *query,
                                                         BeagleQueryDomain domain);
void                beagle_query_remove_domain          (BeagleQuery *query,
                                                         BeagleQueryDomain domain);
void                beagle_query_set_max_hits           (BeagleQuery *query,
                                                         int max_hits);
int                 beagle_query_get_max_hits           (BeagleQuery *query);
GSList *            beagle_query_get_exact_text         (BeagleQuery *query);
GSList *            beagle_query_get_stemmed_text       (BeagleQuery *query);

Object Hierarchy

  GObject
   +----BeagleRequest
         +----BeagleQuery

Signals

  "finished"                                       : Run Last
  "hits-added"                                     : Run Last
  "hits-subtracted"                                : Run Last

Description

Details

enum BeagleQueryDomain

typedef enum {
	BEAGLE_QUERY_DOMAIN_LOCAL        = 1,
	BEAGLE_QUERY_DOMAIN_SYSTEM       = 2,
	BEAGLE_QUERY_DOMAIN_NEIGHBORHOOD = 4,
	BEAGLE_QUERY_DOMAIN_GLOBAL       = 8
} BeagleQueryDomain;


struct BeagleQuery

struct BeagleQuery;


beagle_query_new ()

BeagleQuery *       beagle_query_new                    (void);

Creates a new BeagleQuery.

Returns :

the newly created BeagleQuery.

beagle_query_add_part ()

void                beagle_query_add_part               (BeagleQuery *query,
                                                         BeagleQueryPart *part);

Adds a BeagleQueryPart to the given BeagleQuery.

query :

a BeagleQuery

part :

a BeagleQueryPart

beagle_query_add_text ()

void                beagle_query_add_text               (BeagleQuery *query,
                                                         const char *str);

Adds a text part to the given BeagleQuery.

query :

a BeagleQuery

str :

a string

beagle_query_set_domain ()

void                beagle_query_set_domain             (BeagleQuery *query,
                                                         BeagleQueryDomain domain);

Sets the search domain for a given BeagleQuery. This limits the scope of a search to certain backends.

query :

a BeagleQuery

domain :

a BeagleQueryDomain

beagle_query_add_domain ()

void                beagle_query_add_domain             (BeagleQuery *query,
                                                         BeagleQueryDomain domain);

Adds a search domain to the list of domains to search.

query :

a BeagleQuery

domain :

a BeagleQueryDomain

beagle_query_remove_domain ()

void                beagle_query_remove_domain          (BeagleQuery *query,
                                                         BeagleQueryDomain domain);

Removes a search domain.

query :

a BeagleQuery

domain :

a BeagleQueryDomain

beagle_query_set_max_hits ()

void                beagle_query_set_max_hits           (BeagleQuery *query,
                                                         int max_hits);

Sets the max number of hits a given BeagleQuery should return.

query :

a BeagleQuery

max_hits :

Max number of hits

beagle_query_get_max_hits ()

int                 beagle_query_get_max_hits           (BeagleQuery *query);

Returns the max number of hits a given BeagleQuery should return.

query :

a BeagleQuery

Returns :

Max number of hits

beagle_query_get_exact_text ()

GSList *            beagle_query_get_exact_text         (BeagleQuery *query);

Returns a list of strings which contain the exact text processed by the query. The list should not be modified or freed.

query :

a BeagleQuery

Returns :

A list of strings containing the exact text

beagle_query_get_stemmed_text ()

GSList *            beagle_query_get_stemmed_text       (BeagleQuery *query);

Returns a list of strings which contain the stemmed text processed by the query. The list should not be modified or freed.

query :

a BeagleQuery

Returns :

A list of strings containing the stemmed text

Signal Details

The "finished" signal

void                user_function                      (BeagleQuery            *beaglequery,
                                                        BeagleFinishedResponse *arg1,
                                                        gpointer                user_data)        : Run Last

beaglequery :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "hits-added" signal

void                user_function                      (BeagleQuery             *beaglequery,
                                                        BeagleHitsAddedResponse *arg1,
                                                        gpointer                 user_data)        : Run Last

beaglequery :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "hits-subtracted" signal

void                user_function                      (BeagleQuery                  *beaglequery,
                                                        BeagleHitsSubtractedResponse *arg1,
                                                        gpointer                      user_data)        : Run Last

beaglequery :

the object which received the signal.

user_data :

user data set when the signal handler was connected.