[gtk+/wip/gbsneto/placessidebar-locations] placesview: add some docs
- From: Georges Basile Stavracas Neto <gbsneto src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/wip/gbsneto/placessidebar-locations] placesview: add some docs
- Date: Sun, 31 May 2015 18:49:04 +0000 (UTC)
commit 6c1873e66a111e6a148456e414078466c4f96cbe
Author: Georges Basile Stavracas Neto <georges stavracas gmail com>
Date: Sun May 31 15:48:46 2015 -0300
placesview: add some docs
gtk/gtkplacesview.c | 21 +++++++++++++++++++--
1 files changed, 19 insertions(+), 2 deletions(-)
---
diff --git a/gtk/gtkplacesview.c b/gtk/gtkplacesview.c
index aefe185..72a6b39 100644
--- a/gtk/gtkplacesview.c
+++ b/gtk/gtkplacesview.c
@@ -147,9 +147,15 @@ gtk_places_view_new (void)
}
/**
- * gtkplacesview_func:
+ * gtk_places_view_get_local_only:
+ * @view: a #GtkPlacesView
*
- * %TRUE if only local volumes are shown, %FALSE otherwise.
+ * Returns %TRUE if only local volumes are shown, i.e. no networks
+ * are displayed.
+ *
+ * Returns: %TRUE if only local volumes are shown, %FALSE otherwise.
+ *
+ * Since: 3.18
*/
gboolean
gtk_places_view_get_local_only (GtkPlacesView *view)
@@ -164,6 +170,17 @@ gtk_places_view_get_local_only (GtkPlacesView *view)
return class->get_local_only (view);
}
+/**
+ * gtk_places_view_set_local_only:
+ * @view: a #GtkPlacesView
+ * @local_only: %TRUE to hide remote locations, %FALSE to show.
+ *
+ * Sets the #GtkPlacesView::local-only property to @local_only.
+ *
+ * Returns:
+ *
+ * Since: 3.18
+ */
void
gtk_places_view_set_local_only (GtkPlacesView *view,
gboolean local_only)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]