EventBoxProtocol

public protocol EventBoxProtocol : BinProtocol

The GtkEventBox widget is a subclass of GtkBin which also has its own window. It is useful since it allows you to catch events for widgets which do not have their own window.

The EventBoxProtocol protocol exposes the methods and properties of an underlying GtkEventBox instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see EventBox. Alternatively, use EventBoxRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkEventBox instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • event_box_ptr Default implementation

    Typed pointer to the underlying GtkEventBox instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkEventBox instance.

    Declaration

    Swift

    var event_box_ptr: UnsafeMutablePointer<GtkEventBox>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to EventBoxProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

EventBox Class

  • Bind a EventBoxPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: EventBoxPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a EventBox property

    Declaration

    Swift

    @inlinable
func get(property: EventBoxPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a EventBox property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: EventBoxPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

EventBox Class: EventBoxProtocol extension (methods and fields)

  • getAboveChild() Extension method

    Returns whether the event box window is above or below the windows of its child. See gtk_event_box_set_above_child() for details.

    Declaration

    Swift

    @inlinable
func getAboveChild() -> Bool
    Show on GitHub
  • getVisibleWindow() Extension method

    Returns whether the event box has a visible window. See gtk_event_box_set_visible_window() for details.

    Declaration

    Swift

    @inlinable
func getVisibleWindow() -> Bool
    Show on GitHub
  • set(aboveChild:) Extension method

    Set whether the event box window is positioned above the windows of its child, as opposed to below it. If the window is above, all events inside the event box will go to the event box. If the window is below, events in windows of child widgets will first got to that widget, and then to its parents.

    The default is to keep the window below the child.

    Declaration

    Swift

    @inlinable
func set(aboveChild: Bool)
    Show on GitHub
  • set(visibleWindow:) Extension method

    Set whether the event box uses a visible or invisible child window. The default is to use visible windows.

    In an invisible window event box, the window that the event box creates is a GDK_INPUT_ONLY window, which means that it is invisible and only serves to receive events.

    A visible window event box creates a visible (GDK_INPUT_OUTPUT) window that acts as the parent window for all the widgets contained in the event box.

    You should generally make your event box invisible if you just want to trap events. Creating a visible window may cause artifacts that are visible to the user, especially if the user is using a theme with gradients or pixmaps.

    The main reason to create a non input-only event box is if you want to set the background to a different color or draw on it.

    There is one unexpected issue for an invisible event box that has its window below the child. (See gtk_event_box_set_above_child().) Since the input-only window is not an ancestor window of any windows that descendent widgets of the event box create, events on these windows aren’t propagated up by the windowing system, but only by GTK+. The practical effect of this is if an event isn’t in the event mask for the descendant window (see gtk_widget_add_events()), it won’t be received by the event box.

    This problem doesn’t occur for visible event boxes, because in that case, the event box window is actually the ancestor of the descendant windows, not just at the same place on the screen.

    Declaration

    Swift

    @inlinable
func set(visibleWindow: Bool)
    Show on GitHub
  • aboveChild Extension method

    Returns whether the event box window is above or below the windows of its child. See gtk_event_box_set_above_child() for details.

    Declaration

    Swift

    @inlinable
var aboveChild: Bool { get nonmutating set }
    Show on GitHub
  • visibleWindow Extension method

    Returns whether the event box has a visible window. See gtk_event_box_set_visible_window() for details.

    Declaration

    Swift

    @inlinable
var visibleWindow: Bool { get nonmutating set }
    Show on GitHub
  • bin Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var bin: GtkBin { get }
    Show on GitHub