Class
BisLapel
Description [src]
final class Bis.Lapel : Gtk.Widget {
/* No available fields */
}An adaptive container acting like a box or an overlay.
The BisLapel widget can display its children like a GtkBox does or
like a GtkOverlay does, according to the
BisLapel:fold-policy value.
BisLapel has at most three children: BisLapel:content,
BisLapel:lapel and BisLapel:separator. Content is the primary
child, lapel is displayed next to it when unfolded, or overlays it when
folded. Lapel can be shown or hidden by changing the
BisLapel:reveal-lapel value, as well as via swipe gestures if
BisLapel:swipe-to-open and/or BisLapel:swipe-to-close are set
to TRUE.
Optionally, a separator can be provided, which would be displayed between the content and the lapel when there’s no shadow to separate them, depending on the transition type.
BisLapel:lapel is transparent by default; add the
.background style class to it if this is unwanted.
If BisLapel:modal is set to TRUE, content becomes completely
inaccessible when the lapel is revealed while folded.
The position of the lapel and separator children relative to the content is
determined by orientation, as well as the BisLapel:lapel-position value.
Folding the lapel will automatically hide the lapel widget, and unfolding it
will automatically reveal it. If this behavior is not desired, the
BisLapel:locked property can be used to override it.
Common use cases include sidebars, header bars that need to be able to overlap the window content (for example, in fullscreen mode) and bottom sheets.
BisLapel as GtkBuildable
The BisLapel implementation of the GtkBuildable interface supports
setting the lapel child by specifying “lapel” as the “type” attribute of a
<child> element, and separator by specifying “separator”. Specifying
“content” child type or omitting it results in setting the content child.
CSS nodes
BisLapel has a single CSS node with name lapel. The node will get the style
classes .folded when it is folded, and .unfolded when it’s not.
| Available since: | 1.0 |
Instance methods
bis_lapel_get_fold_duration
Gets the fold transition animation duration for self, in milliseconds.
Available since: 1.0
bis_lapel_get_reveal_params
Gets the reveal animation spring parameters for self.
Available since: 1.0
bis_lapel_get_swipe_to_close
Gets whether self can be closed with a swipe gesture.
Available since: 1.0
bis_lapel_get_swipe_to_open
Gets whether self can be opened with a swipe gesture.
Available since: 1.0
bis_lapel_get_transition_type
Gets the type of animation used for reveal and fold transitions in self.
Available since: 1.0
bis_lapel_set_fold_duration
Sets the fold transition animation duration for self, in milliseconds.
Available since: 1.0
bis_lapel_set_reveal_params
Sets the reveal animation spring parameters for self.
Available since: 1.0
bis_lapel_set_swipe_to_close
Sets whether self can be closed with a swipe gesture.
Available since: 1.0
bis_lapel_set_swipe_to_open
Sets whether self can be opened with a swipe gesture.
Available since: 1.0
bis_lapel_set_transition_type
Sets the type of animation used for reveal and fold transitions in self.
Available since: 1.0
Methods inherited from BisSwipeable (5)
bis_swipeable_get_cancel_progress
Gets the progress self will snap back to after the gesture is canceled.
Available since: 1.0
bis_swipeable_get_distance
Gets the swipe distance of self.
Available since: 1.0
bis_swipeable_get_progress
Gets the current progress of self.
Available since: 1.0
bis_swipeable_get_snap_points
Gets the snap points of self.
Available since: 1.0
bis_swipeable_get_swipe_area
Gets the area self can start a swipe from for the given direction and
gesture type.
Available since: 1.0
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role
Retrieves the GtkAccessibleRole for the given GtkAccessible.
gtk_accessible_reset_property
Resets the accessible property to its default value.
gtk_accessible_reset_relation
Resets the accessible relation to its default value.
gtk_accessible_reset_state
Resets the accessible state to its default value.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable object.
Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation
Retrieves the orientation of the orientable.
gtk_orientable_set_orientation
Sets the orientation of the orientable.
Properties
Bis.Lapel:fold-duration
The fold transition animation duration, in milliseconds.
Available since: 1.0
Bis.Lapel:transition-type
The type of animation used for reveal and fold transitions.
Available since: 1.0
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand property.
Gtk.Widget:layout-manager
The GtkLayoutManager instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible implementation.
Properties inherited from GtkOrientable (1)
Gtk.Orientable:orientation
The orientation of the orientable.
Signals
Signals inherited from GtkWidget (13)
Gtk.Widget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
Gtk.Widget::direction-changed
Emitted when the text direction of a widget changes.
Gtk.Widget::hide
Emitted when widget is hidden.
Gtk.Widget::keynav-failed
Emitted if keyboard navigation fails.
Gtk.Widget::map
Emitted when widget is going to be mapped.
Gtk.Widget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
Gtk.Widget::move-focus
Emitted when the focus is moved.
Gtk.Widget::query-tooltip
Emitted when the widgets tooltip is about to be shown.
Gtk.Widget::realize
Emitted when widget is associated with a GdkSurface.
Gtk.Widget::show
Emitted when widget is shown.
Gtk.Widget::state-flags-changed
Emitted when the widget state changes.
Gtk.Widget::unmap
Emitted when widget is going to be unmapped.
Gtk.Widget::unrealize
Emitted when the GdkSurface associated with widget is destroyed.
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.