| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.ShortcutsSection
Description
A GtkShortcutsSection collects all the keyboard shortcuts and gestures
for a major application mode. If your application needs multiple sections,
you should give each section a unique ShortcutsSection:section-name and
a ShortcutsSection:title that can be shown in the section selector of
the GtkShortcutsWindow.
The ShortcutsSection:max-height property can be used to influence how
the groups in the section are distributed over pages and columns.
This widget is only meant to be used with ShortcutsWindow.
Synopsis
- newtype ShortcutsSection = ShortcutsSection (ManagedPtr ShortcutsSection)
- class (GObject o, IsDescendantOf ShortcutsSection o) => IsShortcutsSection o
- toShortcutsSection :: (MonadIO m, IsShortcutsSection o) => o -> m ShortcutsSection
- constructShortcutsSectionMaxHeight :: (IsShortcutsSection o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getShortcutsSectionMaxHeight :: (MonadIO m, IsShortcutsSection o) => o -> m Word32
- setShortcutsSectionMaxHeight :: (MonadIO m, IsShortcutsSection o) => o -> Word32 -> m ()
- clearShortcutsSectionSectionName :: (MonadIO m, IsShortcutsSection o) => o -> m ()
- constructShortcutsSectionSectionName :: (IsShortcutsSection o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutsSectionSectionName :: (MonadIO m, IsShortcutsSection o) => o -> m (Maybe Text)
- setShortcutsSectionSectionName :: (MonadIO m, IsShortcutsSection o) => o -> Text -> m ()
- clearShortcutsSectionTitle :: (MonadIO m, IsShortcutsSection o) => o -> m ()
- constructShortcutsSectionTitle :: (IsShortcutsSection o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutsSectionTitle :: (MonadIO m, IsShortcutsSection o) => o -> m (Maybe Text)
- setShortcutsSectionTitle :: (MonadIO m, IsShortcutsSection o) => o -> Text -> m ()
- clearShortcutsSectionViewName :: (MonadIO m, IsShortcutsSection o) => o -> m ()
- constructShortcutsSectionViewName :: (IsShortcutsSection o, MonadIO m) => Text -> m (GValueConstruct o)
- getShortcutsSectionViewName :: (MonadIO m, IsShortcutsSection o) => o -> m (Maybe Text)
- setShortcutsSectionViewName :: (MonadIO m, IsShortcutsSection o) => o -> Text -> m ()
- type C_ShortcutsSectionChangeCurrentPageCallback = Ptr () -> Int32 -> Ptr () -> IO CInt
- type ShortcutsSectionChangeCurrentPageCallback = Int32 -> IO Bool
- afterShortcutsSectionChangeCurrentPage :: (IsShortcutsSection a, MonadIO m) => a -> ShortcutsSectionChangeCurrentPageCallback -> m SignalHandlerId
- genClosure_ShortcutsSectionChangeCurrentPage :: MonadIO m => ShortcutsSectionChangeCurrentPageCallback -> m (GClosure C_ShortcutsSectionChangeCurrentPageCallback)
- mk_ShortcutsSectionChangeCurrentPageCallback :: C_ShortcutsSectionChangeCurrentPageCallback -> IO (FunPtr C_ShortcutsSectionChangeCurrentPageCallback)
- noShortcutsSectionChangeCurrentPageCallback :: Maybe ShortcutsSectionChangeCurrentPageCallback
- onShortcutsSectionChangeCurrentPage :: (IsShortcutsSection a, MonadIO m) => a -> ShortcutsSectionChangeCurrentPageCallback -> m SignalHandlerId
- wrap_ShortcutsSectionChangeCurrentPageCallback :: ShortcutsSectionChangeCurrentPageCallback -> C_ShortcutsSectionChangeCurrentPageCallback
Exported types
newtype ShortcutsSection Source #
Memory-managed wrapper type.
Constructors
| ShortcutsSection (ManagedPtr ShortcutsSection) |
Instances
class (GObject o, IsDescendantOf ShortcutsSection o) => IsShortcutsSection o Source #
Type class for types which can be safely cast to ShortcutsSection, for instance with toShortcutsSection.
Instances
| (GObject o, IsDescendantOf ShortcutsSection o) => IsShortcutsSection o Source # | |
Defined in GI.Gtk.Objects.ShortcutsSection | |
toShortcutsSection :: (MonadIO m, IsShortcutsSection o) => o -> m ShortcutsSection Source #
Cast to ShortcutsSection, 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
actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, append, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, insertChildAfter, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, prepend, queueAllocate, queueDraw, queueResize, realize, ref, refSink, remove, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, reorderChildAfter, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.
Getters
getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaselinePosition, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getHomogeneous, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOrientation, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getSpacing, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.
Setters
setBaselinePosition, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setHomogeneous, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOrientation, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setSpacing, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.
Properties
maxHeight
The maximum number of lines to allow per column. This property can be used to influence how the groups in this section are distributed across pages and columns. The default value of 15 should work in most cases.
constructShortcutsSectionMaxHeight :: (IsShortcutsSection o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “max-height” property. This is rarely needed directly, but it is used by new.
getShortcutsSectionMaxHeight :: (MonadIO m, IsShortcutsSection o) => o -> m Word32 Source #
Get the value of the “max-height” property.
When overloading is enabled, this is equivalent to
get shortcutsSection #maxHeight
setShortcutsSectionMaxHeight :: (MonadIO m, IsShortcutsSection o) => o -> Word32 -> m () Source #
Set the value of the “max-height” property.
When overloading is enabled, this is equivalent to
setshortcutsSection [ #maxHeight:=value ]
sectionName
A unique name to identify this section among the sections
added to the GtkShortcutsWindow. Setting the ShortcutsWindow:section-name
property to this string will make this section shown in the
GtkShortcutsWindow.
clearShortcutsSectionSectionName :: (MonadIO m, IsShortcutsSection o) => o -> m () Source #
Set the value of the “section-name” property to Nothing.
When overloading is enabled, this is equivalent to
clear #sectionName
constructShortcutsSectionSectionName :: (IsShortcutsSection o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “section-name” property. This is rarely needed directly, but it is used by new.
getShortcutsSectionSectionName :: (MonadIO m, IsShortcutsSection o) => o -> m (Maybe Text) Source #
Get the value of the “section-name” property.
When overloading is enabled, this is equivalent to
get shortcutsSection #sectionName
setShortcutsSectionSectionName :: (MonadIO m, IsShortcutsSection o) => o -> Text -> m () Source #
Set the value of the “section-name” property.
When overloading is enabled, this is equivalent to
setshortcutsSection [ #sectionName:=value ]
title
The string to show in the section selector of the GtkShortcutsWindow for this section. If there is only one section, you don't need to set a title, since the section selector will not be shown in this case.
clearShortcutsSectionTitle :: (MonadIO m, IsShortcutsSection o) => o -> m () Source #
Set the value of the “title” property to Nothing.
When overloading is enabled, this is equivalent to
clear #title
constructShortcutsSectionTitle :: (IsShortcutsSection o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.
getShortcutsSectionTitle :: (MonadIO m, IsShortcutsSection o) => o -> m (Maybe Text) Source #
Get the value of the “title” property.
When overloading is enabled, this is equivalent to
get shortcutsSection #title
setShortcutsSectionTitle :: (MonadIO m, IsShortcutsSection o) => o -> Text -> m () Source #
Set the value of the “title” property.
When overloading is enabled, this is equivalent to
setshortcutsSection [ #title:=value ]
viewName
A view name to filter the groups in this section by.
See ShortcutsGroup:view.
Applications are expected to use the ShortcutsWindow:view-name
property for this purpose.
clearShortcutsSectionViewName :: (MonadIO m, IsShortcutsSection o) => o -> m () Source #
Set the value of the “view-name” property to Nothing.
When overloading is enabled, this is equivalent to
clear #viewName
constructShortcutsSectionViewName :: (IsShortcutsSection o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct with valid value for the “view-name” property. This is rarely needed directly, but it is used by new.
getShortcutsSectionViewName :: (MonadIO m, IsShortcutsSection o) => o -> m (Maybe Text) Source #
Get the value of the “view-name” property.
When overloading is enabled, this is equivalent to
get shortcutsSection #viewName
setShortcutsSectionViewName :: (MonadIO m, IsShortcutsSection o) => o -> Text -> m () Source #
Set the value of the “view-name” property.
When overloading is enabled, this is equivalent to
setshortcutsSection [ #viewName:=value ]
Signals
changeCurrentPage
type C_ShortcutsSectionChangeCurrentPageCallback = Ptr () -> Int32 -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type ShortcutsSectionChangeCurrentPageCallback = Int32 -> IO Bool Source #
No description available in the introspection data.
afterShortcutsSectionChangeCurrentPage :: (IsShortcutsSection a, MonadIO m) => a -> ShortcutsSectionChangeCurrentPageCallback -> m SignalHandlerId Source #
Connect a signal handler for the changeCurrentPage signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after shortcutsSection #changeCurrentPage callback
genClosure_ShortcutsSectionChangeCurrentPage :: MonadIO m => ShortcutsSectionChangeCurrentPageCallback -> m (GClosure C_ShortcutsSectionChangeCurrentPageCallback) Source #
Wrap the callback into a GClosure.
mk_ShortcutsSectionChangeCurrentPageCallback :: C_ShortcutsSectionChangeCurrentPageCallback -> IO (FunPtr C_ShortcutsSectionChangeCurrentPageCallback) Source #
Generate a function pointer callable from C code, from a C_ShortcutsSectionChangeCurrentPageCallback.
noShortcutsSectionChangeCurrentPageCallback :: Maybe ShortcutsSectionChangeCurrentPageCallback Source #
A convenience synonym for Nothing :: Maybe ShortcutsSectionChangeCurrentPageCallback
onShortcutsSectionChangeCurrentPage :: (IsShortcutsSection a, MonadIO m) => a -> ShortcutsSectionChangeCurrentPageCallback -> m SignalHandlerId Source #
Connect a signal handler for the changeCurrentPage signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on shortcutsSection #changeCurrentPage callback