comp • gb.form • filechooser • bookmarks

FileChooser.Bookmarks (gb.form)

Property Bookmarks As Collection[]

Sets or returns the list of user-defined bookmarks.

The controls FileChooser and DirChooser have their own Bookmark system. To enable it, set the property ShowBookmark to True. The bookmark menu is then visible as a bookmarks MenuButton with a drop-down menu right above the file tree. The drop-down menu might look like this:

Please upload a file

The drop-down menu contains 3 types of bookmarks:

  1. Standard bookmarks

  2. Private bookmarks

  3. User bookmarks

The Bookmarks property documented here concerns type 2: private bookmarks.

Standard bookmarks

The standard bookmarks point to Home and System. Note: You can only see the menu entry Desktop if the component gb.desktop is loaded.

Private bookmarks

Private bookmarks are accessed via the Bookmarks property. Bookmarks is an array of Collections and each bookmark is described by a single Collection object. The Collection must contain a key "Path" that points to the path of the bookmark. Optional keys are "Name" and "Icon" to give the bookmark a name or the path to an icon to display alongside. All other key names are ignored. Private bookmarks are application-specific and are not saved permanently, but created at runtime, e.g.

Public Sub Form_Open()
  Dim cPrivateBookmarks As Collection[]
  Dim cBookmark As Collection

  cPrivateBookmarks = New Collection[]

  ' Create a Collection describing the bookmark
  cBookmark = New Collection
  cBookmark["Path"] = User.Home &/ "Images/Fractals"
  cBookmark["Name"] = "Fractals"
  cBookmark["Icon"] = "icon:/small/plugin"
  cPrivateBookmarks.Add(cBookmark)

  ' Short inline Collection notation
  cPrivateBookmarks.Add(["Path": User.Home &/ "Private/Pictures", "Name": "Pictures", "Icon": "icon:/small/image"])

  Filechooser1.Bookmarks = cPrivateBookmarks
  FileChooser1.ShowBookmark = True
End

User bookmarks

To display user bookmarks, the gb.settings component must be loaded. You can create and edit user bookmarks using the menu items "Bookmark current directory" and "Edit bookmarks". The bookmarks are stored in the file path $HOME/.config/gambas3/gb.form.conf and shared across all your projects using FileChooser and DirChooser (because they belong to the user, not to the project).

Examples

DirChooser1.Bookmarks = [["Path": "/tmp", "Name": "Temporary directory"], ["Path": "/mnt/floppy", "Name": "Floppy disk", "Icon": "icon:/16/floppy"]]

See also

ShowBookmark