| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.PlacesSidebar
Contents
- Exported types
- Methods
- addShortcut
- getLocalOnly
- getLocation
- getNthBookmark
- getOpenFlags
- getShowConnectToServer
- getShowDesktop
- getShowEnterLocation
- getShowOtherLocations
- getShowRecent
- getShowStarredLocation
- getShowTrash
- listShortcuts
- new
- removeShortcut
- setDropTargetsVisible
- setLocalOnly
- setLocation
- setOpenFlags
- setShowConnectToServer
- setShowDesktop
- setShowEnterLocation
- setShowOtherLocations
- setShowRecent
- setShowStarredLocation
- setShowTrash
- Properties
- Signals
Description
PlacesSidebar is a widget that displays a list of frequently-used places in the
file system: the user’s home directory, the user’s bookmarks, and volumes and drives.
This widget is used as a sidebar in FileChooser and may be used by file managers
and similar programs.
The places sidebar displays drives and volumes, and will automatically mount or unmount them when the user selects them.
Applications can hook to various signals in the places sidebar to customize its behavior. For example, they can add extra commands to the context menu of the sidebar.
While bookmarks are completely in control of the user, the places sidebar also
allows individual applications to provide extra shortcut folders that are unique
to each application. For example, a Paint program may want to add a shortcut
for a Clipart folder. You can do this with placesSidebarAddShortcut.
To make use of the places sidebar, an application at least needs to connect
to the PlacesSidebar::openLocation signal. This is emitted when the
user selects in the sidebar a location to open. The application should also
call placesSidebarSetLocation when it changes the currently-viewed
location.
CSS nodes
GtkPlacesSidebar uses a single CSS node with name placessidebar and style class .sidebar.
Among the children of the places sidebar, the following style classes can be used:
- .sidebar-new-bookmark-row for the 'Add new bookmark' row
- .sidebar-placeholder-row for a row that is a placeholder
- .has-open-popup when a popup is open for a row
Synopsis
- newtype PlacesSidebar = PlacesSidebar (ManagedPtr PlacesSidebar)
- class (GObject o, IsDescendantOf PlacesSidebar o) => IsPlacesSidebar o
- toPlacesSidebar :: (MonadIO m, IsPlacesSidebar o) => o -> m PlacesSidebar
- placesSidebarAddShortcut :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsFile b) => a -> b -> m ()
- placesSidebarGetLocalOnly :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarGetLocation :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m (Maybe File)
- placesSidebarGetNthBookmark :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Int32 -> m (Maybe File)
- placesSidebarGetOpenFlags :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m [PlacesOpenFlags]
- placesSidebarGetShowConnectToServer :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarGetShowDesktop :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarGetShowEnterLocation :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarGetShowOtherLocations :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarGetShowRecent :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarGetShowStarredLocation :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarGetShowTrash :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m Bool
- placesSidebarListShortcuts :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> m [File]
- placesSidebarNew :: (HasCallStack, MonadIO m) => m PlacesSidebar
- placesSidebarRemoveShortcut :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsFile b) => a -> b -> m ()
- placesSidebarSetDropTargetsVisible :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsDragContext b) => a -> Bool -> b -> m ()
- placesSidebarSetLocalOnly :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- placesSidebarSetLocation :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsFile b) => a -> Maybe b -> m ()
- placesSidebarSetOpenFlags :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> [PlacesOpenFlags] -> m ()
- placesSidebarSetShowConnectToServer :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- placesSidebarSetShowDesktop :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- placesSidebarSetShowEnterLocation :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- placesSidebarSetShowOtherLocations :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- placesSidebarSetShowRecent :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- placesSidebarSetShowStarredLocation :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- placesSidebarSetShowTrash :: (HasCallStack, MonadIO m, IsPlacesSidebar a) => a -> Bool -> m ()
- constructPlacesSidebarLocalOnly :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarLocalOnly :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarLocalOnly :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- clearPlacesSidebarLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m ()
- constructPlacesSidebarLocation :: (IsPlacesSidebar o, MonadIO m, IsFile a) => a -> m (GValueConstruct o)
- getPlacesSidebarLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m (Maybe File)
- setPlacesSidebarLocation :: (MonadIO m, IsPlacesSidebar o, IsFile a) => o -> a -> m ()
- constructPlacesSidebarOpenFlags :: (IsPlacesSidebar o, MonadIO m) => [PlacesOpenFlags] -> m (GValueConstruct o)
- getPlacesSidebarOpenFlags :: (MonadIO m, IsPlacesSidebar o) => o -> m [PlacesOpenFlags]
- setPlacesSidebarOpenFlags :: (MonadIO m, IsPlacesSidebar o) => o -> [PlacesOpenFlags] -> m ()
- constructPlacesSidebarPopulateAll :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarPopulateAll :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarPopulateAll :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- constructPlacesSidebarShowConnectToServer :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarShowConnectToServer :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarShowConnectToServer :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- constructPlacesSidebarShowDesktop :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarShowDesktop :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarShowDesktop :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- constructPlacesSidebarShowEnterLocation :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarShowEnterLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarShowEnterLocation :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- constructPlacesSidebarShowOtherLocations :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarShowOtherLocations :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarShowOtherLocations :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- constructPlacesSidebarShowRecent :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarShowRecent :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarShowRecent :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- constructPlacesSidebarShowStarredLocation :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarShowStarredLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarShowStarredLocation :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- constructPlacesSidebarShowTrash :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o)
- getPlacesSidebarShowTrash :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool
- setPlacesSidebarShowTrash :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m ()
- type PlacesSidebarDragActionAskCallback = Int32 -> IO Int32
- afterPlacesSidebarDragActionAsk :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionAskCallback) -> m SignalHandlerId
- onPlacesSidebarDragActionAsk :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionAskCallback) -> m SignalHandlerId
- type PlacesSidebarDragActionRequestedCallback = DragContext -> File -> [File] -> IO Int32
- afterPlacesSidebarDragActionRequested :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionRequestedCallback) -> m SignalHandlerId
- onPlacesSidebarDragActionRequested :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionRequestedCallback) -> m SignalHandlerId
- type PlacesSidebarDragPerformDropCallback = File -> [File] -> Int32 -> IO ()
- afterPlacesSidebarDragPerformDrop :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragPerformDropCallback) -> m SignalHandlerId
- onPlacesSidebarDragPerformDrop :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragPerformDropCallback) -> m SignalHandlerId
- type PlacesSidebarMountCallback = MountOperation -> IO ()
- afterPlacesSidebarMount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarMountCallback) -> m SignalHandlerId
- onPlacesSidebarMount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarMountCallback) -> m SignalHandlerId
- type PlacesSidebarOpenLocationCallback = File -> [PlacesOpenFlags] -> IO ()
- afterPlacesSidebarOpenLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarOpenLocationCallback) -> m SignalHandlerId
- onPlacesSidebarOpenLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarOpenLocationCallback) -> m SignalHandlerId
- type PlacesSidebarPopulatePopupCallback = Widget -> Maybe File -> Maybe Volume -> IO ()
- afterPlacesSidebarPopulatePopup :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarPopulatePopupCallback) -> m SignalHandlerId
- onPlacesSidebarPopulatePopup :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarPopulatePopupCallback) -> m SignalHandlerId
- type PlacesSidebarShowConnectToServerCallback = IO ()
- afterPlacesSidebarShowConnectToServer :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowConnectToServerCallback) -> m SignalHandlerId
- onPlacesSidebarShowConnectToServer :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowConnectToServerCallback) -> m SignalHandlerId
- type PlacesSidebarShowEnterLocationCallback = IO ()
- afterPlacesSidebarShowEnterLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowEnterLocationCallback) -> m SignalHandlerId
- onPlacesSidebarShowEnterLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowEnterLocationCallback) -> m SignalHandlerId
- type PlacesSidebarShowErrorMessageCallback = Text -> Text -> IO ()
- afterPlacesSidebarShowErrorMessage :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowErrorMessageCallback) -> m SignalHandlerId
- onPlacesSidebarShowErrorMessage :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowErrorMessageCallback) -> m SignalHandlerId
- type PlacesSidebarShowOtherLocationsCallback = IO ()
- afterPlacesSidebarShowOtherLocations :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsCallback) -> m SignalHandlerId
- onPlacesSidebarShowOtherLocations :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsCallback) -> m SignalHandlerId
- type PlacesSidebarShowOtherLocationsWithFlagsCallback = [PlacesOpenFlags] -> IO ()
- afterPlacesSidebarShowOtherLocationsWithFlags :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsWithFlagsCallback) -> m SignalHandlerId
- onPlacesSidebarShowOtherLocationsWithFlags :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsWithFlagsCallback) -> m SignalHandlerId
- type PlacesSidebarShowStarredLocationCallback = [PlacesOpenFlags] -> IO ()
- afterPlacesSidebarShowStarredLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowStarredLocationCallback) -> m SignalHandlerId
- onPlacesSidebarShowStarredLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowStarredLocationCallback) -> m SignalHandlerId
- type PlacesSidebarUnmountCallback = MountOperation -> IO ()
- afterPlacesSidebarUnmount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarUnmountCallback) -> m SignalHandlerId
- onPlacesSidebarUnmount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarUnmountCallback) -> m SignalHandlerId
Exported types
newtype PlacesSidebar Source #
Memory-managed wrapper type.
Constructors
| PlacesSidebar (ManagedPtr PlacesSidebar) |
Instances
class (GObject o, IsDescendantOf PlacesSidebar o) => IsPlacesSidebar o Source #
Type class for types which can be safely cast to PlacesSidebar, for instance with toPlacesSidebar.
Instances
| (GObject o, IsDescendantOf PlacesSidebar o) => IsPlacesSidebar o Source # | |
Defined in GI.Gtk.Objects.PlacesSidebar | |
toPlacesSidebar :: (MonadIO m, IsPlacesSidebar o) => o -> m PlacesSidebar Source #
Cast to PlacesSidebar, for types for which this is known to be safe. For general casts, use castTo.
Methods
Click to display all available methods, including inherited ones
Methods
activate, add, addAccelerator, addChild, addDeviceEvents, addEvents, addMnemonicLabel, addShortcut, addTickCallback, addWithViewport, bindProperty, bindPropertyFull, canActivateAccel, checkResize, childFocus, childGetProperty, childNotify, childNotifyByPspec, childSetProperty, childType, classPath, computeExpand, constructChild, createPangoContext, createPangoLayout, customFinished, customTagEnd, customTagStart, destroy, destroyed, deviceIsShadowed, dragBegin, dragBeginWithCoordinates, dragCheckThreshold, dragDestAddImageTargets, dragDestAddTextTargets, dragDestAddUriTargets, dragDestFindTarget, dragDestGetTargetList, dragDestGetTrackMotion, dragDestSet, dragDestSetProxy, dragDestSetTargetList, dragDestSetTrackMotion, dragDestUnset, dragGetData, dragHighlight, dragSourceAddImageTargets, dragSourceAddTextTargets, dragSourceAddUriTargets, dragSourceGetTargetList, dragSourceSet, dragSourceSetIconGicon, dragSourceSetIconName, dragSourceSetIconPixbuf, dragSourceSetIconStock, dragSourceSetTargetList, dragSourceUnset, dragUnhighlight, draw, ensureStyle, errorBell, event, forall, forceFloating, foreach, freezeChildNotify, freezeNotify, getv, grabAdd, grabDefault, grabFocus, grabRemove, hasDefault, hasFocus, hasGrab, hasRcStyle, hasScreen, hasVisibleFocus, hide, hideOnDelete, inDestruction, initTemplate, inputShapeCombineRegion, insertActionGroup, intersect, isAncestor, isComposited, isDrawable, isFloating, isFocus, isSensitive, isToplevel, isVisible, keynavFailed, listAccelClosures, listActionPrefixes, listMnemonicLabels, listShortcuts, map, mnemonicActivate, modifyBase, modifyBg, modifyCursor, modifyFg, modifyFont, modifyStyle, modifyText, notify, notifyByPspec, overrideBackgroundColor, overrideColor, overrideCursor, overrideFont, overrideSymbolicColor, parserFinished, path, propagateDraw, queueAllocate, queueComputeExpand, queueDraw, queueDrawArea, queueDrawRegion, queueResize, queueResizeNoRedraw, realize, ref, refSink, regionIntersect, registerWindow, remove, removeAccelerator, removeMnemonicLabel, removeShortcut, removeTickCallback, renderIcon, renderIconPixbuf, reparent, resetRcStyles, resetStyle, resizeChildren, runDispose, sendExpose, sendFocusChange, shapeCombineRegion, show, showAll, showNow, sizeAllocate, sizeAllocateWithBaseline, sizeRequest, stealData, stealQdata, styleAttach, styleGetProperty, thawChildNotify, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unregisterWindow, unsetFocusChain, unsetPlacement, unsetStateFlags, watchClosure.
Getters
getAccessible, getActionGroup, getAllocatedBaseline, getAllocatedHeight, getAllocatedSize, getAllocatedWidth, getAllocation, getAncestor, getAppPaintable, getBorderWidth, getCanDefault, getCanFocus, getCaptureButtonPress, getChild, getChildRequisition, getChildVisible, getChildren, getClip, getClipboard, getCompositeName, getData, getDeviceEnabled, getDeviceEvents, getDirection, getDisplay, getDoubleBuffered, getEvents, getFocusChain, getFocusChild, getFocusHadjustment, getFocusOnClick, getFocusVadjustment, getFontMap, getFontOptions, getFrameClock, getHadjustment, getHalign, getHasTooltip, getHasWindow, getHexpand, getHexpandSet, getHscrollbar, getInternalChild, getKineticScrolling, getLocalOnly, getLocation, getMapped, getMarginBottom, getMarginEnd, getMarginLeft, getMarginRight, getMarginStart, getMarginTop, getMaxContentHeight, getMaxContentWidth, getMinContentHeight, getMinContentWidth, getModifierMask, getModifierStyle, getName, getNoShowAll, getNthBookmark, getOpacity, getOpenFlags, getOverlayScrolling, getPangoContext, getParent, getParentWindow, getPath, getPathForChild, getPlacement, getPointer, getPolicy, getPreferredHeight, getPreferredHeightAndBaselineForWidth, getPreferredHeightForWidth, getPreferredSize, getPreferredWidth, getPreferredWidthForHeight, getPropagateNaturalHeight, getPropagateNaturalWidth, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRequisition, getResizeMode, getRootWindow, getScaleFactor, getScreen, getSensitive, getSettings, getShadowType, getShowConnectToServer, getShowDesktop, getShowEnterLocation, getShowOtherLocations, getShowRecent, getShowStarredLocation, getShowTrash, getSizeRequest, getState, getStateFlags, getStyle, getStyleContext, getSupportMultidevice, getTemplateChild, getTooltipMarkup, getTooltipText, getTooltipWindow, getToplevel, getVadjustment, getValign, getValignWithBaseline, getVexpand, getVexpandSet, getVisible, getVisual, getVscrollbar, getWindow.
Setters
setAccelPath, setAllocation, setAppPaintable, setBorderWidth, setBuildableProperty, setCanDefault, setCanFocus, setCaptureButtonPress, setChildVisible, setClip, setCompositeName, setData, setDataFull, setDeviceEnabled, setDeviceEvents, setDirection, setDoubleBuffered, setDropTargetsVisible, setEvents, setFocusChain, setFocusChild, setFocusHadjustment, setFocusOnClick, setFocusVadjustment, setFontMap, setFontOptions, setHadjustment, setHalign, setHasTooltip, setHasWindow, setHexpand, setHexpandSet, setKineticScrolling, setLocalOnly, setLocation, setMapped, setMarginBottom, setMarginEnd, setMarginLeft, setMarginRight, setMarginStart, setMarginTop, setMaxContentHeight, setMaxContentWidth, setMinContentHeight, setMinContentWidth, setName, setNoShowAll, setOpacity, setOpenFlags, setOverlayScrolling, setParent, setParentWindow, setPlacement, setPolicy, setPropagateNaturalHeight, setPropagateNaturalWidth, setProperty, setRealized, setReallocateRedraws, setReceivesDefault, setRedrawOnAllocate, setResizeMode, setSensitive, setShadowType, setShowConnectToServer, setShowDesktop, setShowEnterLocation, setShowOtherLocations, setShowRecent, setShowStarredLocation, setShowTrash, setSizeRequest, setState, setStateFlags, setStyle, setSupportMultidevice, setTooltipMarkup, setTooltipText, setTooltipWindow, setVadjustment, setValign, setVexpand, setVexpandSet, setVisible, setVisual, setWindow.
addShortcut
placesSidebarAddShortcut Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsFile b) | |
| => a |
|
| -> b |
|
| -> m () |
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
getLocalOnly
placesSidebarGetLocalOnly Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the value previously set with placesSidebarSetLocalOnly.
Since: 3.12
getLocation
placesSidebarGetLocation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m (Maybe File) | Returns: a |
Gets the currently selected location in the sidebar. This can be Nothing when
nothing is selected, for example, when placesSidebarSetLocation 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 PlacesSidebar::populatePopup 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
getNthBookmark
placesSidebarGetNthBookmark Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Int32 |
|
| -> m (Maybe File) | Returns: The bookmark specified by the index |
This function queries the bookmarks added by the user to the places sidebar,
and returns one of them. This function is used by FileChooser to implement
the “Alt-1”, “Alt-2”, etc. shortcuts, which activate the cooresponding bookmark.
Since: 3.10
getOpenFlags
placesSidebarGetOpenFlags Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m [PlacesOpenFlags] | Returns: the |
Gets the open flags.
Since: 3.10
getShowConnectToServer
placesSidebarGetShowConnectToServer Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Deprecated: (Since version 3.18)It is recommended to group this functionality with the drives and network location under the new 'Other Location' item
Returns the value previously set with placesSidebarSetShowConnectToServer
getShowDesktop
placesSidebarGetShowDesktop Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the value previously set with placesSidebarSetShowDesktop
Since: 3.10
getShowEnterLocation
placesSidebarGetShowEnterLocation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the value previously set with placesSidebarSetShowEnterLocation
Since: 3.14
getShowOtherLocations
placesSidebarGetShowOtherLocations Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the value previously set with placesSidebarSetShowOtherLocations
Since: 3.18
getShowRecent
placesSidebarGetShowRecent Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the value previously set with placesSidebarSetShowRecent
Since: 3.18
getShowStarredLocation
placesSidebarGetShowStarredLocation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the value previously set with placesSidebarSetShowStarredLocation
Since: 3.22.26
getShowTrash
placesSidebarGetShowTrash Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the value previously set with placesSidebarSetShowTrash
Since: 3.18
listShortcuts
placesSidebarListShortcuts Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> m [File] | Returns:
A C codeg_slist_free_full (list, (GDestroyNotify) g_object_unref); |
Gets the list of shortcuts.
Since: 3.10
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m PlacesSidebar | Returns: a newly created |
Creates a new PlacesSidebar widget.
The application should connect to at least the PlacesSidebar::openLocation signal to be notified when the user makes a selection in the sidebar.
Since: 3.10
removeShortcut
placesSidebarRemoveShortcut Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsFile b) | |
| => a |
|
| -> b |
|
| -> m () |
Removes an application-specific shortcut that has been previously been
inserted with placesSidebarAddShortcut. If the location is not a
shortcut in the sidebar, then nothing is done.
Since: 3.10
setDropTargetsVisible
placesSidebarSetDropTargetsVisible Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsDragContext b) | |
| => a |
|
| -> Bool |
|
| -> b |
|
| -> m () |
Make the GtkPlacesSidebar show drop targets, so it can show the available drop targets and a "new bookmark" row. This improves the Drag-and-Drop experience of the user and allows applications to show all available drop targets at once.
This needs to be called when the application is aware of an ongoing drag that might target the sidebar. The drop-targets-visible state will be unset automatically if the drag finishes in the GtkPlacesSidebar. You only need to unset the state when the drag ends on some other widget on your application.
Since: 3.18
setLocalOnly
placesSidebarSetLocalOnly Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the sidebar should only show local files.
Since: 3.12
setLocation
placesSidebarSetLocation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a, IsFile b) | |
| => a |
|
| -> Maybe b |
|
| -> m () |
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
setOpenFlags
placesSidebarSetOpenFlags Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> [PlacesOpenFlags] |
|
| -> m () |
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 PlacesSidebar::openLocation signal is emitted, its flags
argument will be set to one of the flags that was passed in
placesSidebarSetOpenFlags.
Passing 0 for flags will cause GTK_PLACES_OPEN_NORMAL to always be sent
to callbacks for the “open-location” signal.
Since: 3.10
setShowConnectToServer
placesSidebarSetShowConnectToServer Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Deprecated: (Since version 3.18)It is recommended to group this functionality with the drives and network location under the new 'Other Location' item
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.
If you enable this, you should connect to the PlacesSidebar::showConnectToServer signal.
Since: 3.10
setShowDesktop
placesSidebarSetShowDesktop Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
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
setShowEnterLocation
placesSidebarSetShowEnterLocation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the sidebar should show an item for entering a location;
this is off by default. An application may want to turn this on if manually
entering URLs is an expected user action.
If you enable this, you should connect to the PlacesSidebar::showEnterLocation signal.
Since: 3.14
setShowOtherLocations
placesSidebarSetShowOtherLocations Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the sidebar should show an item for the application to show
an Other Locations view; this is off by default. When set to True, persistent
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 with drives and network servers directly.
If you enable this, you should connect to the PlacesSidebar::showOtherLocations signal.
Since: 3.18
setShowRecent
placesSidebarSetShowRecent Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the sidebar should show an item for recent files.
The default value for this option is determined by the desktop
environment, but this function can be used to override it on a
per-application basis.
Since: 3.18
setShowStarredLocation
placesSidebarSetShowStarredLocation Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
If you enable this, you should connect to the PlacesSidebar::showStarredLocation signal.
Since: 3.22.26
setShowTrash
placesSidebarSetShowTrash Source #
Arguments
| :: (HasCallStack, MonadIO m, IsPlacesSidebar a) | |
| => a |
|
| -> Bool |
|
| -> m () |
Sets whether the sidebar should show an item for the Trash location.
Since: 3.18
Properties
localOnly
No description available in the introspection data.
constructPlacesSidebarLocalOnly :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “local-only” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarLocalOnly :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “local-only” property.
When overloading is enabled, this is equivalent to
get placesSidebar #localOnly
setPlacesSidebarLocalOnly :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “local-only” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #localOnly:=value ]
location
No description available in the introspection data.
clearPlacesSidebarLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m () Source #
Set the value of the “location” property to Nothing.
When overloading is enabled, this is equivalent to
clear #location
constructPlacesSidebarLocation :: (IsPlacesSidebar o, MonadIO m, IsFile a) => a -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “location” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m (Maybe File) Source #
Get the value of the “location” property.
When overloading is enabled, this is equivalent to
get placesSidebar #location
setPlacesSidebarLocation :: (MonadIO m, IsPlacesSidebar o, IsFile a) => o -> a -> m () Source #
Set the value of the “location” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #location:=value ]
openFlags
No description available in the introspection data.
constructPlacesSidebarOpenFlags :: (IsPlacesSidebar o, MonadIO m) => [PlacesOpenFlags] -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “open-flags” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarOpenFlags :: (MonadIO m, IsPlacesSidebar o) => o -> m [PlacesOpenFlags] Source #
Get the value of the “open-flags” property.
When overloading is enabled, this is equivalent to
get placesSidebar #openFlags
setPlacesSidebarOpenFlags :: (MonadIO m, IsPlacesSidebar o) => o -> [PlacesOpenFlags] -> m () Source #
Set the value of the “open-flags” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #openFlags:=value ]
populateAll
If :populate-all is True, the PlacesSidebar::populatePopup signal
is also emitted for popovers.
Since: 3.18
constructPlacesSidebarPopulateAll :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “populate-all” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarPopulateAll :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “populate-all” property.
When overloading is enabled, this is equivalent to
get placesSidebar #populateAll
setPlacesSidebarPopulateAll :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “populate-all” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #populateAll:=value ]
showConnectToServer
No description available in the introspection data.
constructPlacesSidebarShowConnectToServer :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-connect-to-server” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarShowConnectToServer :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “show-connect-to-server” property.
When overloading is enabled, this is equivalent to
get placesSidebar #showConnectToServer
setPlacesSidebarShowConnectToServer :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “show-connect-to-server” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #showConnectToServer:=value ]
showDesktop
No description available in the introspection data.
constructPlacesSidebarShowDesktop :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-desktop” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarShowDesktop :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “show-desktop” property.
When overloading is enabled, this is equivalent to
get placesSidebar #showDesktop
setPlacesSidebarShowDesktop :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “show-desktop” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #showDesktop:=value ]
showEnterLocation
No description available in the introspection data.
constructPlacesSidebarShowEnterLocation :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-enter-location” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarShowEnterLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “show-enter-location” property.
When overloading is enabled, this is equivalent to
get placesSidebar #showEnterLocation
setPlacesSidebarShowEnterLocation :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “show-enter-location” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #showEnterLocation:=value ]
showOtherLocations
No description available in the introspection data.
constructPlacesSidebarShowOtherLocations :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-other-locations” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarShowOtherLocations :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “show-other-locations” property.
When overloading is enabled, this is equivalent to
get placesSidebar #showOtherLocations
setPlacesSidebarShowOtherLocations :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “show-other-locations” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #showOtherLocations:=value ]
showRecent
No description available in the introspection data.
constructPlacesSidebarShowRecent :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-recent” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarShowRecent :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “show-recent” property.
When overloading is enabled, this is equivalent to
get placesSidebar #showRecent
setPlacesSidebarShowRecent :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “show-recent” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #showRecent:=value ]
showStarredLocation
No description available in the introspection data.
constructPlacesSidebarShowStarredLocation :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-starred-location” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarShowStarredLocation :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “show-starred-location” property.
When overloading is enabled, this is equivalent to
get placesSidebar #showStarredLocation
setPlacesSidebarShowStarredLocation :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “show-starred-location” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #showStarredLocation:=value ]
showTrash
No description available in the introspection data.
constructPlacesSidebarShowTrash :: (IsPlacesSidebar o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “show-trash” property. This is rarely needed directly, but it is used by new.
getPlacesSidebarShowTrash :: (MonadIO m, IsPlacesSidebar o) => o -> m Bool Source #
Get the value of the “show-trash” property.
When overloading is enabled, this is equivalent to
get placesSidebar #showTrash
setPlacesSidebarShowTrash :: (MonadIO m, IsPlacesSidebar o) => o -> Bool -> m () Source #
Set the value of the “show-trash” property.
When overloading is enabled, this is equivalent to
setplacesSidebar [ #showTrash:=value ]
Signals
dragActionAsk
type PlacesSidebarDragActionAskCallback Source #
Arguments
| = Int32 |
|
| -> IO Int32 | Returns: the final drag action that the sidebar should pass to the drag side of the drag-and-drop operation. |
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.
Since: 3.10
afterPlacesSidebarDragActionAsk :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionAskCallback) -> m SignalHandlerId Source #
Connect a signal handler for the dragActionAsk signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #dragActionAsk callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarDragActionAsk :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionAskCallback) -> m SignalHandlerId Source #
Connect a signal handler for the dragActionAsk signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #dragActionAsk callback
dragActionRequested
type PlacesSidebarDragActionRequestedCallback Source #
Arguments
| = DragContext |
|
| -> File |
|
| -> [File] |
|
| -> IO Int32 | Returns: The drag action to use, for example, |
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 sourceFileList against the
possible actions for the destination destFile.
The drag action to use must be the return value of the signal handler.
Since: 3.10
afterPlacesSidebarDragActionRequested :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionRequestedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the dragActionRequested signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #dragActionRequested callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarDragActionRequested :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragActionRequestedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the dragActionRequested signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #dragActionRequested callback
dragPerformDrop
type PlacesSidebarDragPerformDropCallback Source #
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 destFile, and the
sourceFileList has the list of files that are dropped into it and
which should be copied/moved/etc. based on the specified action.
Since: 3.10
afterPlacesSidebarDragPerformDrop :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragPerformDropCallback) -> m SignalHandlerId Source #
Connect a signal handler for the dragPerformDrop signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #dragPerformDrop callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarDragPerformDrop :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarDragPerformDropCallback) -> m SignalHandlerId Source #
Connect a signal handler for the dragPerformDrop signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #dragPerformDrop callback
mount
type PlacesSidebarMountCallback Source #
Arguments
| = MountOperation |
|
| -> IO () |
The places sidebar emits this signal when it starts a new operation
because the user clicked on some location that needs mounting.
In this way the application using the PlacesSidebar can track the
progress of the operation and, for example, show a notification.
Since: 3.20
afterPlacesSidebarMount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarMountCallback) -> m SignalHandlerId Source #
Connect a signal handler for the mount signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #mount callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarMount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarMountCallback) -> m SignalHandlerId Source #
Connect a signal handler for the mount signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #mount callback
openLocation
type PlacesSidebarOpenLocationCallback Source #
Arguments
| = File |
|
| -> [PlacesOpenFlags] |
|
| -> IO () |
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.
Since: 3.10
afterPlacesSidebarOpenLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarOpenLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the openLocation signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #openLocation callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarOpenLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarOpenLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the openLocation signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #openLocation callback
populatePopup
type PlacesSidebarPopulatePopupCallback Source #
Arguments
| = Widget | |
| -> Maybe File |
|
| -> Maybe Volume |
|
| -> IO () |
The places sidebar emits this signal when the user invokes a contextual popup 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 selectedItem for each menu item;
during their callbacks, the application can use placesSidebarGetLocation
to get the file to which the item refers.
The selectedItem argument may be Nothing in case the selection refers to
a volume. In this case, selectedVolume will be non-Nothing. In this case,
the calling application will have to objectRef the selectedVolume and
keep it around to use it in the callback.
The container and all its contents are destroyed after the user
dismisses the popup. The popup is re-created (and thus, this signal is
emitted) every time the user activates the contextual menu.
Before 3.18, the container always was a Menu, and you were expected
to add your items as GtkMenuItems. Since 3.18, the popup may be implemented
as a Popover, in which case container will be something else, e.g. a
Box, to which you may add GtkModelButtons or other widgets, such as
GtkEntries, GtkSpinButtons, etc. If your application can deal with this
situation, you can set PlacesSidebar::populate-all to True to request
that this signal is emitted for populating popovers as well.
Since: 3.10
afterPlacesSidebarPopulatePopup :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarPopulatePopupCallback) -> m SignalHandlerId Source #
Connect a signal handler for the populatePopup signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #populatePopup callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarPopulatePopup :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarPopulatePopupCallback) -> m SignalHandlerId Source #
Connect a signal handler for the populatePopup signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #populatePopup callback
showConnectToServer
type PlacesSidebarShowConnectToServerCallback = IO () Source #
Deprecated: (Since version 3.18)use the PlacesSidebar::showOtherLocations signal to connect to network servers.
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, fileMountEnclosingVolume.
afterPlacesSidebarShowConnectToServer :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowConnectToServerCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showConnectToServer signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #showConnectToServer callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarShowConnectToServer :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowConnectToServerCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showConnectToServer signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #showConnectToServer callback
showEnterLocation
type PlacesSidebarShowEnterLocationCallback = IO () Source #
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".
Since: 3.14
afterPlacesSidebarShowEnterLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowEnterLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showEnterLocation signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #showEnterLocation callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarShowEnterLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowEnterLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showEnterLocation signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #showEnterLocation callback
showErrorMessage
type PlacesSidebarShowErrorMessageCallback Source #
Arguments
| = Text |
|
| -> Text |
|
| -> IO () |
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.
Since: 3.10
afterPlacesSidebarShowErrorMessage :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowErrorMessageCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showErrorMessage signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #showErrorMessage callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarShowErrorMessage :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowErrorMessageCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showErrorMessage signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #showErrorMessage callback
showOtherLocations
type PlacesSidebarShowOtherLocationsCallback = IO () Source #
Deprecated: (Since version 3.20)use the PlacesSidebar::showOtherLocationsWithFlagswhich includes the open flags in order to allow the user to specify to openin a new tab or window, in a similar way than PlacesSidebar::openLocation
The places sidebar emits this signal when it needs the calling application to present a way to show other locations e.g. drives and network access points. For example, the application may bring up a page showing persistent volumes and discovered network addresses.
Since: 3.18
afterPlacesSidebarShowOtherLocations :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showOtherLocations signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #showOtherLocations callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarShowOtherLocations :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showOtherLocations signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #showOtherLocations callback
showOtherLocationsWithFlags
type PlacesSidebarShowOtherLocationsWithFlagsCallback Source #
Arguments
| = [PlacesOpenFlags] |
|
| -> IO () |
The places sidebar emits this signal when it needs the calling application to present a way to show other locations e.g. drives and network access points. For example, the application may bring up a page showing persistent volumes and discovered network addresses.
Since: 3.20
afterPlacesSidebarShowOtherLocationsWithFlags :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsWithFlagsCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showOtherLocationsWithFlags signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #showOtherLocationsWithFlags callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarShowOtherLocationsWithFlags :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowOtherLocationsWithFlagsCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showOtherLocationsWithFlags signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #showOtherLocationsWithFlags callback
showStarredLocation
type PlacesSidebarShowStarredLocationCallback Source #
Arguments
| = [PlacesOpenFlags] |
|
| -> IO () |
The places sidebar emits this signal when it needs the calling application to present a way to show the starred files. In GNOME, starred files are implemented by setting the nao:predefined-tag-favorite tag in the tracker database.
Since: 3.22.26
afterPlacesSidebarShowStarredLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowStarredLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showStarredLocation signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #showStarredLocation callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarShowStarredLocation :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarShowStarredLocationCallback) -> m SignalHandlerId Source #
Connect a signal handler for the showStarredLocation signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #showStarredLocation callback
unmount
type PlacesSidebarUnmountCallback Source #
Arguments
| = MountOperation |
|
| -> IO () |
The places sidebar emits this signal when it starts a new operation
because the user for example ejected some drive or unmounted a mount.
In this way the application using the PlacesSidebar can track the
progress of the operation and, for example, show a notification.
Since: 3.20
afterPlacesSidebarUnmount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarUnmountCallback) -> m SignalHandlerId Source #
Connect a signal handler for the unmount signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after placesSidebar #unmount callback
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self parameter.
Note that this requires activating the ImplicitParams GHC extension.
onPlacesSidebarUnmount :: (IsPlacesSidebar a, MonadIO m) => a -> ((?self :: a) => PlacesSidebarUnmountCallback) -> m SignalHandlerId Source #
Connect a signal handler for the unmount signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on placesSidebar #unmount callback