BeagleSnippetRequest

BeagleSnippetRequest —

Synopsis




            BeagleSnippetRequest;
BeagleSnippetRequest* beagle_snippet_request_new
                                            (void);
void        beagle_snippet_request_set_hit  (BeagleSnippetRequest *request,
                                             BeagleHit *hit);
void        beagle_snippet_request_add_query_term
                                            (BeagleSnippetRequest *request,
                                             const char *text);
void        beagle_snippet_request_set_query_terms_from_query
                                            (BeagleSnippetRequest *request,
                                             BeagleQuery *query);


Object Hierarchy


  GObject
   +----BeagleRequest
         +----BeagleSnippetRequest

Description

Details

BeagleSnippetRequest

typedef struct _BeagleSnippetRequest BeagleSnippetRequest;


beagle_snippet_request_new ()

BeagleSnippetRequest* beagle_snippet_request_new
                                            (void);

Creates a new BeagleSnippetRequest.

Returns : the newly created BeagleSnippetRequest.

beagle_snippet_request_set_hit ()

void        beagle_snippet_request_set_hit  (BeagleSnippetRequest *request,
                                             BeagleHit *hit);

Sets the hit on the given BeagleSnippetRequest.

request : a BeagleSnippetRequest
hit : a BeagleHit

beagle_snippet_request_add_query_term ()

void        beagle_snippet_request_add_query_term
                                            (BeagleSnippetRequest *request,
                                             const char *text);

Add a query term to the given BeagleSnippetRequest.

request : a BeagleSnippetRequest
text : a string

beagle_snippet_request_set_query_terms_from_query ()

void        beagle_snippet_request_set_query_terms_from_query
                                            (BeagleSnippetRequest *request,
                                             BeagleQuery *query);

Set the query terms of the given BeagleSnippetRequest from the passed in BeagleQuery.

request : a BeagleSnippetRequest
query : a BeagleQuery