diff options
| author | Wu Xiaotian <[email protected]> | 2019-08-19 17:05:03 +0800 |
|---|---|---|
| committer | raveit65 <[email protected]> | 2019-08-26 14:21:14 +0200 |
| commit | 18f8b7ab6417aecf62c7b2a311190c70de12e17c (patch) | |
| tree | 18479d6d606f075c2afa18550cdee3be021123c8 | |
| parent | 00f68491bad7d3cd06e013f3bdba4282f9afcf62 (diff) | |
| download | caja-18f8b7ab6417aecf62c7b2a311190c70de12e17c.tar.bz2 caja-18f8b7ab6417aecf62c7b2a311190c70de12e17c.tar.xz | |
add document for CajaWidgetViewProvider api
| -rw-r--r-- | docs/reference/libcaja-extension/libcaja-extension.types | 1 | ||||
| -rw-r--r-- | libcaja-extension/caja-widget-view-provider.c | 44 | ||||
| -rw-r--r-- | libcaja-extension/caja-widget-view-provider.h | 12 |
3 files changed, 43 insertions, 14 deletions
diff --git a/docs/reference/libcaja-extension/libcaja-extension.types b/docs/reference/libcaja-extension/libcaja-extension.types index 2c52af5d..1a354053 100644 --- a/docs/reference/libcaja-extension/libcaja-extension.types +++ b/docs/reference/libcaja-extension/libcaja-extension.types @@ -6,6 +6,7 @@ caja_property_page_get_type caja_info_provider_get_type caja_column_get_type caja_column_provider_get_type +caja_widget_view_provider_get_type caja_menu_provider_get_type caja_menu_get_type caja_menu_item_get_type diff --git a/libcaja-extension/caja-widget-view-provider.c b/libcaja-extension/caja-widget-view-provider.c index 44b33001..c2bab2ba 100644 --- a/libcaja-extension/caja-widget-view-provider.c +++ b/libcaja-extension/caja-widget-view-provider.c @@ -70,8 +70,9 @@ caja_widget_view_provider_get_type (void) * caja_widget_view_provider_get_widget: * @provider: a #CajaWidgetViewProvider * + * Return a #GtkWidget to show the current location content. * - * Returns: + * Returns: The #GtkWidget used to show the contents. **/ GtkWidget * caja_widget_view_provider_get_widget (CajaWidgetViewProvider *provider) @@ -85,10 +86,10 @@ caja_widget_view_provider_get_widget (CajaWidgetViewProvider *provider) /** * caja_widget_view_provider_add_file: * @provider: a #CajaWidgetViewProvider - * @file: - * @directory: - * + * @file: add a #CajaFile into the widget view. + * @directory: the directory of the file. * + * Add a file of this location into the widget view. **/ void caja_widget_view_provider_add_file (CajaWidgetViewProvider *provider, CajaFile *file, CajaFile *directory) { @@ -103,7 +104,7 @@ void caja_widget_view_provider_add_file (CajaWidgetViewProvider *provider, CajaF * @provider: a #CajaWidgetViewProvider * @uri: the URI of the location * - * + * Set the location of this #CajaWidgetViewProvider. **/ void caja_widget_view_provider_set_location (CajaWidgetViewProvider *provider, const char *location) { @@ -118,7 +119,7 @@ void caja_widget_view_provider_set_location (CajaWidgetViewProvider *provider, c * @provider: a #CajaWidgetViewProvider * @window: parent #GtkWindow * - * + * Set parent #GtkWindow of this #CajaWidgetViewProvider. **/ void caja_widget_view_provider_set_window (CajaWidgetViewProvider *provider, GtkWindow *window) { @@ -128,6 +129,12 @@ void caja_widget_view_provider_set_window (CajaWidgetViewProvider *provider, Gtk CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->set_window (provider, window); } +/** + * caja_widget_view_provider_get_item_count: + * @provider: a #CajaWidgetViewProvider + * + * Return value: The item count of this #CajaWidgetViewProvider + **/ guint caja_widget_view_provider_get_item_count (CajaWidgetViewProvider *provider) { g_return_val_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider), 0); @@ -136,6 +143,15 @@ guint caja_widget_view_provider_get_item_count (CajaWidgetViewProvider *provider return CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->get_item_count (provider); } +/** + * caja_widget_view_provider_get_first_visible_file: + * @provider: a #CajaWidgetViewProvider + * + * Return the first visible file. When use start visit the location, the caja's status is waiting, until + * get the first visible file. + * + * Return value: the first visible file. + **/ gchar* caja_widget_view_provider_get_first_visible_file (CajaWidgetViewProvider *provider) { g_return_val_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider), NULL); @@ -144,6 +160,12 @@ gchar* caja_widget_view_provider_get_first_visible_file (CajaWidgetViewProvider return CAJA_WIDGET_VIEW_PROVIDER_GET_IFACE (provider)->get_first_visible_file (provider); } +/** + * caja_widget_view_provider_clear: + * @provider: a #CajaWidgetViewProvider + * + * Clear the content of this widget view. + **/ void caja_widget_view_provider_clear (CajaWidgetViewProvider *provider) { g_return_if_fail (CAJA_IS_WIDGET_VIEW_PROVIDER (provider)); @@ -155,13 +177,13 @@ void caja_widget_view_provider_clear (CajaWidgetViewProvider *provider) /** * caja_widget_view_provider_supports_uri: * @provider: a #CajaWidgetViewProvider - * @uri: - * @file_type: - * @mime_type: - * + * @uri: the location to visit. + * @file_type: The #GFileType for the uri + * @mime_type: The mimetype for the uri * + * Whether this widget view works for the uri. * - * Return value: + * Return value: True to use custom widget view, False to ignore, and caja use normal view. **/ gboolean caja_widget_view_provider_supports_uri (CajaWidgetViewProvider *provider, const char *uri, diff --git a/libcaja-extension/caja-widget-view-provider.h b/libcaja-extension/caja-widget-view-provider.h index e232d3b8..1b6e7cfb 100644 --- a/libcaja-extension/caja-widget-view-provider.h +++ b/libcaja-extension/caja-widget-view-provider.h @@ -39,11 +39,17 @@ typedef struct _CajaWidgetViewProviderIface CajaWidgetViewProviderIface; /** * CajaWidgetViewProviderIface: - * @g_iface: The parent interface. + * @supports_uri: Whether this extension works for this uri * @get_widget: Returns a #GtkWidget. - * See caja_widget_view_provider_get_widget() for details. + * See caja_widget_view_provider_get_widget() for details. + * @add_file: Adds a file to this widget view. + * @set_location: Set location to this widget view. + * @set_window: Set the main window to this widget view. + * @get_item_count: Return the item count of this widget view. + * @get_first_visible_file: Return the first visible file from this widget view. + * @clear: Clear items in this widget view. * - * Interface for extensions to provide widgets view. + * Interface for extensions to provide widgets view for content. */ struct _CajaWidgetViewProviderIface { GTypeInterface g_iface; |