Find Manager
[System]

Defines

#define ALP_STATUS_FIND_CANCELLED (ALP_CLASS_FIND | 0x0005)

Find was cancelled; stop searching.

Functions

alp_status_t alp_find_results_end (void)

Signal that the find client is done searching.

alp_status_t alp_find_results_start (void)

Signal that the find client will be sending back results of a search.

alp_status_t alp_find_results_submit_one (const gchar *app, const char *key, const GdkPixbuf *icon, const gchar *primary_desc, const gchar *secondary_desc)

Send a search result to the find engine.

alp_status_t alp_find_results_submit_progress (const gchar *description)

Send a progress message to the find engine for display.

Define Documentation

#define ALP_STATUS_FIND_CANCELLED (ALP_CLASS_FIND | 0x0005)

Find was cancelled; stop searching.
The search was cancelled for some reason (e.g. "Cancel", e.g. user clicked on a search result) and the find client application should now stop searching and return to its previous state.

Function Documentation

alp_status_t alp_find_results_end ( void )

Signal that the find client is done searching.
A "find client" application calls alp_find_results_end to close the connection to the find engine and signal that the find engine may invoke the next application for searching.

Returns:
ALP_STATUS_OK or any error encountered by the underlying implementation, like an IPC error.

alp_status_t alp_find_results_start ( void )

Signal that the find client will be sending back results of a search.
A "find client" application calls alp_find_results_start to open a connection to the find engine and signal that results may be forthcoming.

Returns:
ALP_STATUS_OK or any error encountered by the underlying implementation, like an IPC error.

alp_status_t alp_find_results_submit_one ( const gchar * app,

const char * key,

const GdkPixbuf * icon,

const gchar * primary_desc,

const gchar * secondary_desc

)

Send a search result to the find engine.
This provides all search results to the find engine (the find "GUI").

Parameters:

[in] app The string name of the bundle whose application should be launched if the user selects this result in the displayed list of results, or NULL if this app should be launched.

[in] key The string key to provide to the launched app if if the user selects this result in the displayed list of results.

[in] icon A (small) icon that represents this find entry, or NULL to the Launcher icon for the calling program. As examples, a calendar program might pass NULL, in which case the same stylized mini-calendar that the launcher displays would be displayed in the search results; and an address book program might pass the picture of the person in the addressbook entry.

[in] primary_desc A string to display as the "primary" description of this search result.

[in] secondary_desc A string to display as the "secondary" description of this search result. In the system "Find" gadget, the secondary description is shown under the primary description, in a slightly smaller font, and slightly indented.

Returns:
ALP_STATUS_OK if successful
ALP_STATUS_FIND_CANCELLED if the search was cancelled. The application should stop searching and return to its previous state.
Any error encountered by the underlying implementation of Find, like an IPC error.

alp_status_t alp_find_results_submit_progress ( const gchar * description )

Send a progress message to the find engine for display.
Provide a very short string that signals to the user what the searching application ("find client") is doing. Typically this is displayed to the used by being appended to "Searching " in the real-time results of a search in the "Find" GUI. For example, an email program reading the supply "Inbox", in which case the user sees "Searching Inbox...", and then supply "Read Emails", in which case the user sees "Searching Read Emails..."

Parameters:

[in] description A string with a short progress description.

Returns:
ALP_STATUS_OK or any error encountered by the underlying implementation, like an IPC error.

Generated on Wed Jul 30 07:06:42 2008 by Doxygen 1.4.6 for ALP SDK + Hiker Documentation


Defines
#define	ALP_STATUS_FIND_CANCELLED (ALP_CLASS_FIND \| 0x0005)
	Find was cancelled; stop searching.
Functions
alp_status_t	alp_find_results_end (void)
	Signal that the find client is done searching.
alp_status_t	alp_find_results_start (void)
	Signal that the find client will be sending back results of a search.
alp_status_t	alp_find_results_submit_one (const gchar app, const char key, const GdkPixbuf icon, const gchar primary_desc, const gchar *secondary_desc)
	Send a search result to the find engine.
alp_status_t	alp_find_results_submit_progress (const gchar *description)
	Send a progress message to the find engine for display.

Find Manager [System]

Defines

Functions

Define Documentation

Function Documentation

Find Manager
[System]