AppstreamSearchQuery

AppstreamSearchQuery — Class describing a query on the AppStream application database

Synopsis

#define             APPSTREAM_TYPE_SEARCH_QUERY
gboolean            appstream_search_query_get_search_all_categories
                                                        (AppstreamSearchQuery *self);
void                appstream_search_query_set_search_all_categories
                                                        (AppstreamSearchQuery *self);
void                appstream_search_query_set_categories_from_string
                                                        (AppstreamSearchQuery *self,
                                                         const gchar *categories_str);
AppstreamSearchQuery * appstream_search_query_new       (const gchar *term);
const gchar *       appstream_search_query_get_search_term
                                                        (AppstreamSearchQuery *self);
void                appstream_search_query_set_search_term
                                                        (AppstreamSearchQuery *self,
                                                         const gchar *value);
gchar **            appstream_search_query_get_categories
                                                        (AppstreamSearchQuery *self,
                                                         int *result_length1);
void                appstream_search_query_set_categories
                                                        (AppstreamSearchQuery *self,
                                                         gchar **value,
                                                         int value_length1);
struct              AppstreamSearchQuery;
struct              AppstreamSearchQueryClass;
#define             APPSTREAM_TYPE_DATABASE
gboolean            appstream_database_open             (AppstreamDatabase *self);
gboolean            appstream_database_db_exists        (AppstreamDatabase *self);
GPtrArray *         appstream_database_get_all_applications
                                                        (AppstreamDatabase *self);
GPtrArray *         appstream_database_find_applications
                                                        (AppstreamDatabase *self,
                                                         AppstreamSearchQuery *query);
GPtrArray *         appstream_database_find_applications_by_str
                                                        (AppstreamDatabase *self,
                                                         const gchar *search_str,
                                                         const gchar *categories_str);
AppstreamDatabase * appstream_database_new              (void);
const gchar *       appstream_database_get_database_path
                                                        (AppstreamDatabase *self);
struct              AppstreamDatabase;
struct              AppstreamDatabaseClass;

Description

Details

APPSTREAM_TYPE_SEARCH_QUERY

#define APPSTREAM_TYPE_SEARCH_QUERY (appstream_search_query_get_type ())

The type for AppstreamSearchQuery.


appstream_search_query_get_search_all_categories ()

gboolean            appstream_search_query_get_search_all_categories
                                                        (AppstreamSearchQuery *self);

self :

the AppstreamSearchQuery instance

Returns :

TRUE if we search in all categories

appstream_search_query_set_search_all_categories ()

void                appstream_search_query_set_search_all_categories
                                                        (AppstreamSearchQuery *self);

Shortcut to set that we should search in all categories

self :

the AppstreamSearchQuery instance

appstream_search_query_set_categories_from_string ()

void                appstream_search_query_set_categories_from_string
                                                        (AppstreamSearchQuery *self,
                                                         const gchar *categories_str);

Set the categories list from a string

self :

the AppstreamSearchQuery instance

categories_str :

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

appstream_search_query_new ()

AppstreamSearchQuery * appstream_search_query_new       (const gchar *term);

term :

 

appstream_search_query_get_search_term ()

const gchar *       appstream_search_query_get_search_term
                                                        (AppstreamSearchQuery *self);

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

self :

the AppstreamSearchQuery instance to query

Returns :

the value of the "search-term" property

appstream_search_query_set_search_term ()

void                appstream_search_query_set_search_term
                                                        (AppstreamSearchQuery *self,
                                                         const gchar *value);

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

self :

the AppstreamSearchQuery instance to modify

value :

the new value of the "search-term" property

appstream_search_query_get_categories ()

gchar **            appstream_search_query_get_categories
                                                        (AppstreamSearchQuery *self,
                                                         int *result_length1);

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

self :

the AppstreamSearchQuery instance to query

Returns :

the value of the "categories" property

appstream_search_query_set_categories ()

void                appstream_search_query_set_categories
                                                        (AppstreamSearchQuery *self,
                                                         gchar **value,
                                                         int value_length1);

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

self :

the AppstreamSearchQuery instance to modify

value :

the new value of the "categories" property

struct AppstreamSearchQuery

struct AppstreamSearchQuery {
	GObject parent_instance;
	AppstreamSearchQueryPrivate * priv;
};

Class describing a query on the AppStream application database


struct AppstreamSearchQueryClass

struct AppstreamSearchQueryClass {
	GObjectClass parent_class;
};

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

GObjectClass parent_class;

the parent class structure

APPSTREAM_TYPE_DATABASE

#define APPSTREAM_TYPE_DATABASE (appstream_database_get_type ())

The type for AppstreamDatabase.


appstream_database_open ()

gboolean            appstream_database_open             (AppstreamDatabase *self);

self :

the AppstreamDatabase instance

appstream_database_db_exists ()

gboolean            appstream_database_db_exists        (AppstreamDatabase *self);

self :

the AppstreamDatabase instance

Returns :

TRUE if the application database exists

appstream_database_get_all_applications ()

GPtrArray *         appstream_database_get_all_applications
                                                        (AppstreamDatabase *self);

self :

the AppstreamDatabase instance

appstream_database_find_applications ()

GPtrArray *         appstream_database_find_applications
                                                        (AppstreamDatabase *self,
                                                         AppstreamSearchQuery *query);

self :

the AppstreamDatabase instance

query :

 

appstream_database_find_applications_by_str ()

GPtrArray *         appstream_database_find_applications_by_str
                                                        (AppstreamDatabase *self,
                                                         const gchar *search_str,
                                                         const gchar *categories_str);

self :

the AppstreamDatabase instance

search_str :

 

categories_str :

 

appstream_database_new ()

AppstreamDatabase * appstream_database_new              (void);

appstream_database_get_database_path ()

const gchar *       appstream_database_get_database_path
                                                        (AppstreamDatabase *self);

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

self :

the AppstreamDatabase instance to query

Returns :

the value of the "database-path" property

struct AppstreamDatabase

struct AppstreamDatabase {
	GObject parent_instance;
	AppstreamDatabasePrivate * priv;
};

Class to access the AppStream application database


struct AppstreamDatabaseClass

struct AppstreamDatabaseClass {
	GObjectClass parent_class;
	gboolean (*open) (AppstreamDatabase* self);
};

The class structure for APPSTREAM_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 appstream_database_open()