BeagleQuery

BeagleQuery

Functions

Signals

void finished Run Last
void hits-added Run Last
void hits-subtracted Run Last

Types and Values

Object Hierarchy

    GObject
    ╰── BeagleRequest
        ╰── BeagleQuery

Description

Functions

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

query

a BeagleQuery

 

domain

a BeagleQueryDomain

 

beagle_query_remove_domain ()

void
beagle_query_remove_domain (BeagleQuery *query,
                            BeagleQueryDomain domain);

Removes a search domain.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

query

a BeagleQuery

 

Returns

A list of strings containing the stemmed text

Types and Values

enum BeagleQueryDomain

Members

BEAGLE_QUERY_DOMAIN_LOCAL

   

BEAGLE_QUERY_DOMAIN_SYSTEM

   

BEAGLE_QUERY_DOMAIN_NEIGHBORHOOD

   

BEAGLE_QUERY_DOMAIN_GLOBAL

   

struct BeagleQuery

struct BeagleQuery;

Signal Details

The “finished” signal

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

Parameters

beaglequery

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “hits-added” signal

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

Parameters

beaglequery

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last


The “hits-subtracted” signal

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

Parameters

beaglequery

the object which received the signal.

 

user_data

user data set when the signal handler was connected.

 

Flags: Run Last