AsSearchQuery

AsSearchQuery — Class describing a query on the AppStream application database

Synopsis

#define             AS_TYPE_SEARCH_QUERY
gboolean            as_search_query_get_search_all_categories
                                                        (AsSearchQuery *self);
void                as_search_query_set_search_all_categories
                                                        (AsSearchQuery *self);
void                as_search_query_set_categories_from_string
                                                        (AsSearchQuery *self,
                                                         const gchar *categories_str);
AsSearchQuery *     as_search_query_new                 (const gchar *term);
const gchar *       as_search_query_get_search_term     (AsSearchQuery *self);
void                as_search_query_set_search_term     (AsSearchQuery *self,
                                                         const gchar *value);
gchar **            as_search_query_get_categories      (AsSearchQuery *self,
                                                         int *result_length1);
void                as_search_query_set_categories      (AsSearchQuery *self,
                                                         gchar **value,
                                                         int value_length1);
struct              AsSearchQuery;
struct              AsSearchQueryClass;
#define             AS_TYPE_DATABASE
gboolean            as_database_open                    (AsDatabase *self);
gboolean            as_database_db_exists               (AsDatabase *self);
GPtrArray *         as_database_get_all_applications    (AsDatabase *self);
GPtrArray *         as_database_find_applications       (AsDatabase *self,
                                                         AsSearchQuery *query);
GPtrArray *         as_database_find_applications_by_str
                                                        (AsDatabase *self,
                                                         const gchar *search_str,
                                                         const gchar *categories_str);
AsDatabase *        as_database_new                     (void);
const gchar *       as_database_get_database_path       (AsDatabase *self);
struct              AsDatabase;
struct              AsDatabaseClass;

Description

Details

AS_TYPE_SEARCH_QUERY

#define AS_TYPE_SEARCH_QUERY (as_search_query_get_type ())

The type for AsSearchQuery.


as_search_query_get_search_all_categories ()

gboolean            as_search_query_get_search_all_categories
                                                        (AsSearchQuery *self);

self :

the AsSearchQuery instance

Returns :

TRUE if we search in all categories

as_search_query_set_search_all_categories ()

void                as_search_query_set_search_all_categories
                                                        (AsSearchQuery *self);

Shortcut to set that we should search in all categories

self :

the AsSearchQuery instance

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

self :

the AsSearchQuery instance

categories_str :

 . Comma-separated list of category-names. [in]

as_search_query_new ()

AsSearchQuery *     as_search_query_new                 (const gchar *term);

term :

 

as_search_query_get_search_term ()

const gchar *       as_search_query_get_search_term     (AsSearchQuery *self);

Get and return the current value of the "search-term" property.

self :

the AsSearchQuery instance to query

Returns :

the value of the "search-term" property

as_search_query_set_search_term ()

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

Set the value of the "search-term" property to value.

self :

the AsSearchQuery instance to modify

value :

the new value of the "search-term" property

as_search_query_get_categories ()

gchar **            as_search_query_get_categories      (AsSearchQuery *self,
                                                         int *result_length1);

Get and return the current value of the "categories" property.

self :

the AsSearchQuery instance to query

Returns :

the value of the "categories" property

as_search_query_set_categories ()

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

Set the value of the "categories" property to value.

self :

the AsSearchQuery instance to modify

value :

the new value of the "categories" property

struct AsSearchQuery

struct AsSearchQuery {
	GObject parent_instance;
	AsSearchQueryPrivate * priv;
};

Class describing a query on the AppStream application database


struct AsSearchQueryClass

struct AsSearchQueryClass {
	GObjectClass parent_class;
};

The class structure for AS_TYPE_SEARCH_QUERY. All the fields in this structure are private and should never be accessed directly.

GObjectClass parent_class;

the parent class structure

AS_TYPE_DATABASE

#define AS_TYPE_DATABASE (as_database_get_type ())

The type for AsDatabase.


as_database_open ()

gboolean            as_database_open                    (AsDatabase *self);

self :

the AsDatabase instance

as_database_db_exists ()

gboolean            as_database_db_exists               (AsDatabase *self);

self :

the AsDatabase instance

Returns :

TRUE if the application database exists

as_database_get_all_applications ()

GPtrArray *         as_database_get_all_applications    (AsDatabase *self);

self :

the AsDatabase instance

as_database_find_applications ()

GPtrArray *         as_database_find_applications       (AsDatabase *self,
                                                         AsSearchQuery *query);

self :

the AsDatabase instance

query :

 

as_database_find_applications_by_str ()

GPtrArray *         as_database_find_applications_by_str
                                                        (AsDatabase *self,
                                                         const gchar *search_str,
                                                         const gchar *categories_str);

self :

the AsDatabase instance

search_str :

 

categories_str :

 

as_database_new ()

AsDatabase *        as_database_new                     (void);

as_database_get_database_path ()

const gchar *       as_database_get_database_path       (AsDatabase *self);

Get and return the current value of the "database-path" property.

self :

the AsDatabase instance to query

Returns :

the value of the "database-path" property

struct AsDatabase

struct AsDatabase {
	GObject parent_instance;
	AsDatabasePrivate * priv;
};

Class to access the AppStream application database


struct AsDatabaseClass

struct AsDatabaseClass {
	GObjectClass parent_class;
	gboolean (*open) (AsDatabase* self);
};

The class structure for AS_TYPE_DATABASE. All the fields in this structure are private and should never be accessed directly.

GObjectClass parent_class;

the parent class structure

open ()

virtual method called by as_database_open()