AsSearchQuery

AsSearchQuery — An Appstream database search query

Synopsis

#include <appstream.h>

struct              AsSearchQuery;
struct              AsSearchQueryClass;
AsSearchQuery *     as_search_query_new                 (const gchar *term);
AsSearchQuery *     as_search_query_construct           (GType object_type,
                                                         const gchar *term);
void                as_search_query_set_search_term     (AsSearchQuery *self,
                                                         const gchar *value);
gboolean            as_search_query_get_search_all_categories
                                                        (AsSearchQuery *self);
gchar **            as_search_query_get_categories      (AsSearchQuery *self);
void                as_search_query_set_search_all_categories
                                                        (AsSearchQuery *self);
void                as_search_query_set_categories      (AsSearchQuery *self,
                                                         gchar **value);
void                as_search_query_set_categories_from_string
                                                        (AsSearchQuery *self,
                                                         const gchar *categories_str);
void                as_search_query_sanitize_search_term
                                                        (AsSearchQuery *self);
const gchar *       as_search_query_get_search_term     (AsSearchQuery *self);

Object Hierarchy

  GObject
   +----AsSearchQuery

Properties

  "categories"               GStrv                 : Read / Write
  "search-term"              gchar*                : Read / Write

Description

This object defines a search run in the Appstream components database. It contains a string to search for, as well as information which categories should be searched. It also applies some sanity checks and improvements to the entered search string.

See also: AsDatabase

Details

struct AsSearchQuery

struct AsSearchQuery;


struct AsSearchQueryClass

struct AsSearchQueryClass {
	GObjectClass parent_class;
};


as_search_query_new ()

AsSearchQuery *     as_search_query_new                 (const gchar *term);

Creates a new AsSearchQuery.

Returns :

an AsSearchQuery. [transfer full]

as_search_query_construct ()

AsSearchQuery *     as_search_query_construct           (GType object_type,
                                                         const gchar *term);


as_search_query_set_search_term ()

void                as_search_query_set_search_term     (AsSearchQuery *self,
                                                         const gchar *value);


as_search_query_get_search_all_categories ()

gboolean            as_search_query_get_search_all_categories
                                                        (AsSearchQuery *self);

Returns :

TRUE if we search in all categories

as_search_query_get_categories ()

gchar **            as_search_query_get_categories      (AsSearchQuery *self);


as_search_query_set_search_all_categories ()

void                as_search_query_set_search_all_categories
                                                        (AsSearchQuery *self);


as_search_query_set_categories ()

void                as_search_query_set_categories      (AsSearchQuery *self,
                                                         gchar **value);


as_search_query_set_categories_from_string ()

void                as_search_query_set_categories_from_string
                                                        (AsSearchQuery *self,
                                                         const gchar *categories_str);

Set the categories list from a string

categories_str Semicolon-separated list of category-names


as_search_query_sanitize_search_term ()

void                as_search_query_sanitize_search_term
                                                        (AsSearchQuery *self);


as_search_query_get_search_term ()

const gchar *       as_search_query_get_search_term     (AsSearchQuery *self);

Property Details

The "categories" property

  "categories"               GStrv                 : Read / Write

categories.


The "search-term" property

  "search-term"              gchar*                : Read / Write

search-term.

Default value: NULL