PlacesSidebar

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool local_only { get; set; }
• public File location { owned get; set; }
• public PlacesOpenFlags open_flags { get; set; }
• public bool populate_all { get; set; }
  If populate_all is true, the populate_popup signal is also emitted for popovers.
• public bool show_connect_to_server { get; set; }
• public bool show_desktop { get; set; }
• public bool show_enter_location { get; set; }
• public bool show_other_locations { get; set; }
• public bool show_recent { get; set; }
• public bool show_starred_location { get; set; }
• public bool show_trash { get; set; }

Creation methods:

• public PlacesSidebar ()
  Creates a new PlacesSidebar widget.

Methods:

• public void add_shortcut (File location)
  Applications may want to present some folders in the places sidebar if they could be immediately useful to users.
• public bool get_local_only ()
  Returns the value previously set with set_local_only.
• public File? get_location ()
  Gets the currently selected location in the this.
• public File? get_nth_bookmark (int n)
  This function queries the bookmarks added by the user to the places sidebar, and returns one of them.
• public PlacesOpenFlags get_open_flags ()
  Gets the open flags.
• public bool get_show_connect_to_server ()
  Returns the value previously set with set_show_connect_to_server
• public bool get_show_desktop ()
  Returns the value previously set with set_show_desktop
• public bool get_show_enter_location ()
  Returns the value previously set with set_show_enter_location
• public bool get_show_other_locations ()
  Returns the value previously set with set_show_other_locations
• public bool get_show_recent ()
  Returns the value previously set with set_show_recent
• public bool get_show_starred_location ()
  Returns the value previously set with set_show_starred_location
• public bool get_show_trash ()
  Returns the value previously set with set_show_trash
• public SList<File> list_shortcuts ()
  Gets the list of shortcuts.
• public void remove_shortcut (File location)
  Removes an application-specific shortcut that has been previously been inserted with add_shortcut.
• public void set_drop_targets_visible (bool visible, DragContext context)
  Make the GtkPlacesSidebar show drop targets, so it can show the available drop targets and a "new bookmark" row.
• public void set_local_only (bool local_only)
  Sets whether the this should only show local files.
• public void set_location (File? location)
  Sets the location that is being shown in the widgets surrounding the this, for example, in a folder view in a file manager.
• public void set_open_flags (PlacesOpenFlags flags)
  Sets the way in which the calling application can open new locations from the places sidebar.
• public void set_show_connect_to_server (bool show_connect_to_server)
  Sets whether the this should show an item for connecting to a network server; this is off by default.
• public void set_show_desktop (bool show_desktop)
  Sets whether the this should show an item for the Desktop folder.
• public void set_show_enter_location (bool show_enter_location)
  Sets whether the this should show an item for entering a location; this is off by default.
• public void set_show_other_locations (bool show_other_locations)
  Sets whether the this should show an item for the application to show an Other Locations view; this is off by default.
• public void set_show_recent (bool show_recent)
  Sets whether the this should show an item for recent files.
• public void set_show_starred_location (bool show_starred_location)
  If you enable this, you should connect to the on_show_starred_location signal.
• public void set_show_trash (bool show_trash)
  Sets whether the this should show an item for the Trash location.

Signals:

• public signal int drag_action_ask (int actions)
  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.
• public signal int drag_action_requested (DragContext context, File dest_file, List<File> source_file_list)
  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.
• public signal void drag_perform_drop (File dest_file, List<File> source_file_list, int action)
  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.
• public signal void mount (MountOperation mount_operation)
  The places sidebar emits this signal when it starts a new operation because the user clicked on some location that needs mounting.
• public signal void on_show_connect_to_server ()
  The places sidebar emits this signal when it needs the calling application to present an way to connect directly to a network server.
• public signal void on_show_enter_location ()
  The places sidebar emits this signal when it needs the calling application to present an way to directly enter a location.
• public signal void on_show_starred_location (PlacesOpenFlags open_flags)
  The places sidebar emits this signal when it needs the calling application to present a way to show the starred files.
• public signal void open_location (File location, PlacesOpenFlags open_flags)
  The places sidebar emits this signal when the user selects a location in it.
• public signal void populate_popup (Widget container, File? selected_item, Volume? selected_volume)
  The places sidebar emits this signal when the user invokes a contextual popup on one of its items.
• public signal void show_error_message (string primary, string secondary)
  The places sidebar emits this signal when it needs the calling application to present an error message.
• public signal void show_other_locations_requested ()
  The places sidebar emits this signal when it needs the calling application to present a way to show other locations e.
• public signal void show_other_locations_with_flags (PlacesOpenFlags open_flags)
  The places sidebar emits this signal when it needs the calling application to present a way to show other locations e.
• public signal void unmount (MountOperation mount_operation)
  The places sidebar emits this signal when it starts a new operation because the user for example ejected some drive or unmounted a mount.

Inherited Members: