gtk_places_sidebar_new ()

GtkWidget *
gtk_places_sidebar_new (void);

Creates a new GtkPlacesSidebar widget.

The application should connect to at least the “open-location” signal to be notified when the user makes a selection in the sidebar.

Since 3.10

gtk_places_sidebar_set_open_flags ()

void
gtk_places_sidebar_set_open_flags (GtkPlacesSidebar *sidebar,
                                   GtkPlacesOpenFlags flags);

Sets the way in which the calling application can open new locations from the places sidebar. For example, some applications only open locations “directly” into their main view, while others may support opening locations in a new notebook tab or a new window.

This function is used to tell the places sidebar about the ways in which the application can open new locations, so that the sidebar can display (or not) the “Open in new tab” and “Open in new window” menu items as appropriate.

When the “open-location” signal is emitted, its flags argument will be set to one of the flags that was passed in gtk_places_sidebar_set_open_flags().

Passing 0 for flags will cause GTK_PLACES_OPEN_NORMAL to always be sent to callbacks for the “open-location” signal.

Since 3.10

gtk_places_sidebar_get_open_flags ()

GtkPlacesOpenFlags
gtk_places_sidebar_get_open_flags (GtkPlacesSidebar *sidebar);

Gets the open flags.

Since 3.10

gtk_places_sidebar_set_location ()

void
gtk_places_sidebar_set_location (GtkPlacesSidebar *sidebar,
                                 GFile *location);

Sets the location that is being shown in the widgets surrounding the sidebar , for example, in a folder view in a file manager. In turn, the sidebar will highlight that location if it is being shown in the list of places, or it will unhighlight everything if the location is not among the places in the list.

Since 3.10

gtk_places_sidebar_get_location ()

GFile *
gtk_places_sidebar_get_location (GtkPlacesSidebar *sidebar);

Gets the currently-selected location in the sidebar . This can be NULL when nothing is selected, for example, when gtk_places_sidebar_set_location() has been called with a location that is not among the sidebar’s list of places to show.

You can use this function to get the selection in the sidebar . Also, if you connect to the “populate-popup” signal, you can use this function to get the location that is being referred to during the callbacks for your menu items.

Since 3.10

gtk_places_sidebar_set_show_desktop ()

void
gtk_places_sidebar_set_show_desktop (GtkPlacesSidebar *sidebar,
                                     gboolean show_desktop);

Sets whether the sidebar should show an item for the Desktop folder. The default value for this option is determined by the desktop environment and the user’s configuration, but this function can be used to override it on a per-application basis.

Since 3.10

gtk_places_sidebar_get_show_desktop ()

gboolean
gtk_places_sidebar_get_show_desktop (GtkPlacesSidebar *sidebar);

Returns the value previously set with gtk_places_sidebar_set_show_desktop()

Since 3.10

gtk_places_sidebar_add_shortcut ()

void
gtk_places_sidebar_add_shortcut (GtkPlacesSidebar *sidebar,
                                 GFile *location);

Applications may want to present some folders in the places sidebar if they could be immediately useful to users. For example, a drawing program could add a “/usr/share/clipart” location when the sidebar is being used in an “Insert Clipart” dialog box.

This function adds the specified location to a special place for immutable shortcuts. The shortcuts are application-specific; they are not shared across applications, and they are not persistent. If this function is called multiple times with different locations, then they are added to the sidebar’s list in the same order as the function is called.

Since 3.10

gtk_places_sidebar_remove_shortcut ()

void
gtk_places_sidebar_remove_shortcut (GtkPlacesSidebar *sidebar,
                                    GFile *location);

Removes an application-specific shortcut that has been previously been inserted with gtk_places_sidebar_add_shortcut(). If the location is not a shortcut in the sidebar, then nothing is done.

Since 3.10

gtk_places_sidebar_list_shortcuts ()

GSList *
gtk_places_sidebar_list_shortcuts (GtkPlacesSidebar *sidebar);

Gets the list of shortcuts.

1

g_slist_free_full (list, (GDestroyNotify) g_object_unref);

Since 3.10

gtk_places_sidebar_get_nth_bookmark ()

GFile *
gtk_places_sidebar_get_nth_bookmark (GtkPlacesSidebar *sidebar,
                                     gint n);

This function queries the bookmarks added by the user to the places sidebar, and returns one of them. This function is used by GtkFileChooser to implement the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark.

Since 3.10

gtk_places_sidebar_get_show_connect_to_server ()

gboolean
gtk_places_sidebar_get_show_connect_to_server
                               (GtkPlacesSidebar *sidebar);

Returns the value previously set with gtk_places_sidebar_set_show_connect_to_server()

Since 3.10

gtk_places_sidebar_set_show_connect_to_server ()

void
gtk_places_sidebar_set_show_connect_to_server
                               (GtkPlacesSidebar *sidebar,
                                gboolean show_connect_to_server);

Sets whether the sidebar should show an item for connecting to a network server; 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.

Since 3.10

gtk_places_sidebar_get_local_only ()

gboolean
gtk_places_sidebar_get_local_only (GtkPlacesSidebar *sidebar);

Returns the value previously set with gtk_places_sidebar_set_local_only().

Since 3.12

gtk_places_sidebar_set_local_only ()

void
gtk_places_sidebar_set_local_only (GtkPlacesSidebar *sidebar,
                                   gboolean local_only);

Sets whether the sidebar should only show local files.

Since 3.12

gtk_places_sidebar_get_show_enter_location ()

gboolean
gtk_places_sidebar_get_show_enter_location
                               (GtkPlacesSidebar *sidebar);

Returns the value previously set with gtk_places_sidebar_set_show_enter_location()

Since 3.14

gtk_places_sidebar_set_show_enter_location ()

void
gtk_places_sidebar_set_show_enter_location
                               (GtkPlacesSidebar *sidebar,
                                gboolean show_enter_location);

Sets whether the sidebar should show an item for connecting to a network server; 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.

Since 3.14

GtkPlacesSidebar

typedef struct _GtkPlacesSidebar GtkPlacesSidebar;

enum GtkPlacesOpenFlags

These flags serve two purposes. First, the application can call gtk_places_sidebar_set_open_flags() using these flags as a bitmask. This tells the sidebar that the application is able to open folders selected from the sidebar in various ways, for example, in new tabs or in new windows in addition to the normal mode.

Second, when one of these values gets passed back to the application in the “open-location” signal, it means that the application should open the selected location in the normal way, in a new tab, or in a new window. The sidebar takes care of determining the desired way to open the location, based on the modifier keys that the user is pressing at the time the selection is made.

If the application never calls gtk_places_sidebar_set_open_flags(), then the sidebar will only use GTK_PLACES_OPEN_NORMAL in the “open-location” signal. This is the default mode of operation.

The “local-only” property

  “local-only”               gboolean

Whether the sidebar only includes local files.

Flags: Read / Write

Default value: FALSE

The “location” property

  “location”                 GFile *

The location to highlight in the sidebar.

Flags: Read / Write

The “open-flags” property

  “open-flags”               GtkPlacesOpenFlags

Modes in which the calling application can open locations selected in the sidebar.

Flags: Read / Write

Default value: GTK_PLACES_OPEN_NORMAL

The “show-connect-to-server” property

  “show-connect-to-server”   gboolean

Whether the sidebar includes a builtin shortcut to a 'Connect to server' dialog.

Flags: Read / Write

Default value: FALSE

The “show-desktop” property

  “show-desktop”             gboolean

Whether the sidebar includes a builtin shortcut to the Desktop folder.

Flags: Read / Write

Default value: TRUE

The “show-enter-location” property

  “show-enter-location”      gboolean

Whether the sidebar includes a builtin shortcut to manually enter a location.

Flags: Read / Write

Default value: FALSE

The “drag-action-ask” signal

gint
user_function (GtkPlacesSidebar *sidebar,
               gint              actions,
               gpointer          user_data)

The places sidebar emits this signal when it needs to ask the application to pop up a menu to ask the user for which drag action to perform.

Flags: Run Last

Since 3.10

The “drag-action-requested” signal

gint
user_function (GtkPlacesSidebar *sidebar,
               GdkDragContext   *context,
               GObject          *dest_file,
               gpointer          source_file_list,
               gpointer          user_data)

When the user starts a drag-and-drop operation and the sidebar needs to ask the application for which drag action to perform, then the sidebar will emit this signal.

The application can evaluate the context for customary actions, or it can check the type of the files indicated by source_file_list against the possible actions for the destination dest_file .

The drag action to use must be the return value of the signal handler.

Flags: Run Last

Since 3.10

The “drag-perform-drop” signal

void
user_function (GtkPlacesSidebar *sidebar,
               GObject          *dest_file,
               gpointer          source_file_list,
               gint              action,
               gpointer          user_data)

The places sidebar emits this signal when the user completes a drag-and-drop operation and one of the sidebar's items is the destination. This item is in the dest_file , and the source_file_list has the list of files that are dropped into it and which should be copied/moved/etc. based on the specified action .

Flags: Run First

Since 3.10

The “open-location” signal

void
user_function (GtkPlacesSidebar  *sidebar,
               GObject           *location,
               GtkPlacesOpenFlags open_flags,
               gpointer           user_data)

The places sidebar emits this signal when the user selects a location in it. The calling application should display the contents of that location; for example, a file manager should show a list of files in the specified location.

Flags: Run First

Since 3.10

The “populate-popup” signal

void
user_function (GtkPlacesSidebar *sidebar,
               GObject          *menu,
               GObject          *selected_item,
               GObject          *selected_volume,
               gpointer          user_data)

The places sidebar emits this signal when the user invokes a contextual menu on one of its items. In the signal handler, the application may add extra items to the menu as appropriate. For example, a file manager may want to add a "Properties" command to the menu.

It is not necessary to store the selected_item for each menu item; during their GtkMenuItem::activate callbacks, the application can use gtk_places_sidebar_get_location() to get the file to which the item refers.

The selected_item argument may be NULL in case the selection refers to a volume. In this case, selected_volume will be non-NULL. In this case, the calling application will have to g_object_ref() the selected_volume and keep it around for the purposes of its menu item's "activate" callback.

The menu and all its menu items are destroyed after the user dismisses the menu. The menu is re-created (and thus, this signal is emitted) every time the user activates the contextual menu.

Flags: Run First

Since 3.10

The “show-connect-to-server” signal

void
user_function (GtkPlacesSidebar *sidebar,
               gpointer          user_data)

The places sidebar emits this signal when it needs the calling application to present an way to connect directly to a network server. For example, the application may bring up a dialog box asking for a URL like "sftp://ftp.example.com". It is up to the application to create the corresponding mount by using, for example, g_file_mount_enclosing_volume().

Flags: Run First

Since 3.10

The “show-enter-location” signal

void
user_function (GtkPlacesSidebar *sidebar,
               gpointer          user_data)

The places sidebar emits this signal when it needs the calling application to present an way to directly enter a location. For example, the application may bring up a dialog box asking for a URL like "http://http.example.com".

Flags: Run First

Since 3.14

The “show-error-message” signal

void
user_function (GtkPlacesSidebar *sidebar,
               gchar            *primary,
               gchar            *secondary,
               gpointer          user_data)

The places sidebar emits this signal when it needs the calling application to present an error message. Most of these messages refer to mounting or unmounting media, for example, when a drive cannot be started for some reason.

Flags: Run First

Since 3.10