Class
ClapperGtkLeadContainer
Description [src]
class ClapperGtk.LeadContainer : ClapperGtk.Container
implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
/* No available fields */
}
A ClapperGtkContainer
that can take priority in user interactions with the ClapperGtkVideo
.
ClapperGtkLeadContainer
is a special type of ClapperGtkContainer
that can
lead in interaction events. When “leading”, it is assumed that user interactions
over it which would normally trigger actions can be blocked/ignored when set in mask
of actions that this widget should block.
This kind of container is useful when creating some statically visible overlays
covering top of ClapperGtkVideo
that you want to take priority instead of
triggering default actions such as toggle play on click or revealing fading overlays.
For more info how container widget works see ClapperGtkContainer
documentation.
Instance methods
clapper_gtk_lead_container_get_blocked_actions
Get actions
that were set for this lead_container
to block.
clapper_gtk_lead_container_set_blocked_actions
Set actions
that ClapperGtkVideo
should skip when GdkEvent
which
would normally trigger them happens inside lead_container
.
Methods inherited from ClapperGtkContainer (10)
clapper_gtk_container_get_adaptive_height
Get a container
adaptive height threshold.
clapper_gtk_container_get_adaptive_width
Get a container
adaptive width threshold.
clapper_gtk_container_get_child
Get a child GtkWidget
of container
.
clapper_gtk_container_get_height_target
Get a container
height target.
clapper_gtk_container_get_width_target
Get a container
width target.
clapper_gtk_container_set_adaptive_height
Set an adaptive height threshold. When widget is resized to value or lower,
an ClapperGtkContainer::adapt
signal will be emitted with TRUE
to
notify implementation about mobile adaptation request, otherwise FALSE
when
both threshold values are exceeded.
clapper_gtk_container_set_adaptive_width
Set an adaptive width threshold. When widget is resized to value or lower,
an ClapperGtkContainer::adapt
signal will be emitted with TRUE
to
notify implementation about mobile adaptation request, otherwise FALSE
when
both threshold values are exceeded.
clapper_gtk_container_set_child
Set a child GtkWidget
of container
.
clapper_gtk_container_set_height_target
Same as clapper_gtk_container_set_width_target()
but for widget height.
clapper_gtk_container_set_width_target
Set a width that container
should target. When set container
will not stretch beyond set width
while still expanding into
possible boundaries trying to reach its target.
Methods inherited from GtkAccessible (19)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the accessible implementation for the given GtkAccessible
.
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
gtk_accessible_get_platform_state
Query a platform state, such as focus.
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_set_accessible_parent
Sets the parent and sibling of an accessible object.
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling of self
.
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.
Properties
ClapperGtk.LeadContainer:blocked-actions
Mask of actions that container blocks from being triggered on video.
Properties inherited from ClapperGtkContainer (4)
ClapperGtk.Container:adaptive-height
Adaptive height threshold that triggers ClapperGtkContainer::adapt
signal.
ClapperGtk.Container:adaptive-width
Adaptive width threshold that triggers ClapperGtkContainer::adapt
signal.
ClapperGtk.Container:height-target
Height that container should target.
ClapperGtk.Container:width-target
Width that container should target.
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.
Signals
Signals inherited from ClapperGtkContainer (1)
ClapperGtkContainer::adapt
A helper signal for implementing mobile/narrow adaptive behavior on descendants.
Signals inherited from GtkWidget (13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
GtkWidget::hide
Emitted when widget
is hidden.
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
GtkWidget::map
Emitted when widget
is going to be mapped.
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
GtkWidget::move-focus
Emitted when the focus is moved.
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
GtkWidget::realize
Emitted when widget
is associated with a GdkSurface
.
GtkWidget::show
Emitted when widget
is shown.
GtkWidget::state-flags-changed
Emitted when the widget state changes.
GtkWidget::unmap
Emitted when widget
is going to be unmapped.
GtkWidget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
Signals inherited from GObject (1)
GObject::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.