callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

places view: Documentation fixups

Browse Source 
Rewrite gtk_places_sidebar_set_show_enter_location docs, add
references to the relevant signals, remove mentions of
GtkPlacesView from the docs, since it is not public at this point.

https://bugzilla.gnome.org/show_bug.cgi?id=752633
This commit is contained in:
Matthias Clasen 2015-07-25 12:11:05 -04:00
parent f9d903995d
commit 69d90d4f50
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
gtk/gtkplacessidebar.c
View File

@ -4275,8 +4275,7 @@ gtk_places_sidebar_class_init (GtkPlacesSidebarClass *class)
* application to present a way to show other locations e.g. drives * application to present a way to show other locations e.g. drives
* and network access points. * and network access points.
* For example, the application may bring up a page showing persistent * For example, the application may bring up a page showing persistent
* volumes and discovered network addresses. #GtkPlacesView is the * volumes and discovered network addresses.
* prime example of how to handle them.
* *
* Since: 3.18 * Since: 3.18
*/ */
@ -4664,6 +4663,9 @@ gtk_places_sidebar_get_show_desktop (GtkPlacesSidebar *sidebar)
* this is off by default. An application may want to turn this on if it implements * this is off by default. An application may want to turn this on if it implements
* a way for the user to connect to network servers directly. * a way for the user to connect to network servers directly.
* *
* If you enable this, you should connect to the
* #GtkPlacesSidebar::show-connect-to-server signal.
*
* Since: 3.10 * Since: 3.10
* *
* Deprecated: 3.18: It is recommended to group this functionality with the drives * Deprecated: 3.18: It is recommended to group this functionality with the drives
@ -4705,11 +4707,14 @@ gtk_places_sidebar_get_show_connect_to_server (GtkPlacesSidebar *sidebar)
/** /**
* gtk_places_sidebar_set_show_enter_location: * gtk_places_sidebar_set_show_enter_location:
* @sidebar: a places sidebar * @sidebar: a places sidebar
* @show_enter_location: whether to show an item for the Connect to Server command * @show_enter_location: whether to show an item to enter a location
* *
* Sets whether the @sidebar should show an item for connecting to a network server; this is off by default. * Sets whether the @sidebar should show an item for entering a location;
* An application may want to turn this on if it implements a way for the user to connect * this is off by default. An application may want to turn this on if manually
* to network servers directly. * entering URLs is an expected user action.
*
* If you enable this, you should connect to the
* #GtkPlacesSidebar::show-enter-location signal.
* *
* Deprecated: 3.18: use gtk_places_sidebar_set_show_other_locations() instead. * Deprecated: 3.18: use gtk_places_sidebar_set_show_other_locations() instead.
*/ */
@ -4751,12 +4756,14 @@ gtk_places_sidebar_get_show_enter_location (GtkPlacesSidebar *sidebar)
* @sidebar: a places sidebar * @sidebar: a places sidebar
* @show_other_locations: whether to show an item for the Other Locations view * @show_other_locations: whether to show an item for the Other Locations view
* *
* Sets whether the @sidebar should show an item for the application to show an Other Locations * Sets whether the @sidebar should show an item for the application to show
* view; this is off by default. When set to %TRUE, persistent devices such as hard drives are * an Other Locations view; this is off by default. When set to %TRUE, persistent
* hidden, otherwise they are shown in the sidebar. * devices such as hard drives are hidden, otherwise they are shown in the sidebar.
* An application may want to turn this on if it implements a way for the user to see and interact * An application may want to turn this on if it implements a way for the user to
* with drives and network servers directly. #GtkPlacesView is the reference implementation for * see and interact with drives and network servers directly.
* it. *
* If you enable this, you should connect to the
* #GtkPlacesSidebar::show-other-locations signal.
* *
* Since: 3.18 * Since: 3.18
*/ */