BeagleSnippetRequest

BeagleSnippetRequest

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── BeagleRequest
        ╰── BeagleSnippetRequest

Description

Functions

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.

Parameters

request

a BeagleSnippetRequest

 

hit

a BeagleHit

 

beagle_snippet_request_set_query ()

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

Set the query of the given BeagleSnippetRequest from which to pull query terms.

Parameters

request

a BeagleSnippetRequest

 

query

a BeagleQuery

 

beagle_snippet_request_set_context_length ()

void
beagle_snippet_request_set_context_length
                               (BeagleSnippetRequest *request,
                                gint ctx_length);

Set the number of maximum number of words before or after the matching query term. The default value is 6.

Parameters

request

a BeagleSnippetRequest

 

ctx_length

the number of context words

 

beagle_snippet_request_set_full_text ()

void
beagle_snippet_request_set_full_text (BeagleSnippetRequest *request,
                                      gboolean full_text);

Request full cached text of this hit. The text will not be marked with search terms for performance reasons.

Parameters

request

a BeagleSnippetRequest

 

full_text

boolean

 

beagle_snippet_request_set_snippet_length ()

void
beagle_snippet_request_set_snippet_length
                               (BeagleSnippetRequest *request,
                                gint snp_length);

Set the maximum number of characters for this snippet.

Parameters

request

a BeagleSnippetRequest

 

snp_length

maximum length of the snippet

 

Types and Values

struct BeagleSnippetRequest

struct BeagleSnippetRequest;