FontButtonProtocol

public protocol FontButtonProtocol : FontChooserProtocol, WidgetProtocol

The GtkFontButton allows to open a font chooser dialog to change the font.

An example GtkFontButton

It is suitable widget for selecting a font in a preference dialog.

CSS nodes

fontbutton
╰── button.font
    ╰── [content]

GtkFontButton has a single CSS node with name fontbutton which contains a button node with the .font style class.

The FontButtonProtocol protocol exposes the methods and properties of an underlying GtkFontButton 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 FontButton. Alternatively, use FontButtonRef 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 GtkFontButton instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkFontButton instance.

    Default Implementation

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

    Declaration

    Swift

    var font_button_ptr: UnsafeMutablePointer<GtkFontButton>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to FontButtonProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

FontButton Class

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: FontButtonPropertyName, 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 FontButton property

    Declaration

    Swift

    @inlinable
func get(property: FontButtonPropertyName) -> 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 FontButton property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

FontButton signals

  • Connect a Swift signal handler to the given, typed FontButtonSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: FontButtonSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed FontButtonSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: FontButtonSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onActivate(flags:handler:) Extension method

    Emitted to when the font button is activated.

    The activate signal on GtkFontButton is an action signal and emitting it causes the button to present its dialog.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: FontButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the activate signal is emitted
    Show on GitHub
  • activateSignal Extension method

    Typed activate signal for using the connect(signal:) methods

    Declaration

    Swift

    static var activateSignal: FontButtonSignalName { get }
    Show on GitHub
  • onFontSet(flags:handler:) Extension method

    Emitted when the user selects a font.

    When handling this signal, use [methodGtk.FontChooser.get_font] to find out which font was just selected.

    Note that this signal is only emitted when the user changes the font. If you need to react to programmatic font changes as well, use the notifyfont signal.

    Note

    This represents the underlying font-set signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onFontSet(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: FontButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the fontSet signal is emitted
    Show on GitHub
  • fontSetSignal Extension method

    Typed font-set signal for using the connect(signal:) methods

    Declaration

    Swift

    static var fontSetSignal: FontButtonSignalName { get }
    Show on GitHub

  • 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.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::modal signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyModal(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: FontButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyModal signal is emitted
    Show on GitHub
  • notifyModalSignal Extension method

    Typed notify::modal signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyModalSignal: FontButtonSignalName { get }
    Show on GitHub

  • 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.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::title signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyTitle(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: FontButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyTitle signal is emitted
    Show on GitHub
  • notifyTitleSignal Extension method

    Typed notify::title signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyTitleSignal: FontButtonSignalName { get }
    Show on GitHub

  • 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.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::use-font signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyUseFont(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: FontButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyUseFont signal is emitted
    Show on GitHub
  • notifyUseFontSignal Extension method

    Typed notify::use-font signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyUseFontSignal: FontButtonSignalName { get }
    Show on GitHub

  • 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.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::use-size signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyUseSize(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: FontButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyUseSize signal is emitted
    Show on GitHub
  • notifyUseSizeSignal Extension method

    Typed notify::use-size signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyUseSizeSignal: FontButtonSignalName { get }
    Show on GitHub

FontButton Class: FontButtonProtocol extension (methods and fields)

  • getModal() Extension method

    Gets whether the dialog is modal.

    Declaration

    Swift

    @inlinable
func getModal() -> Bool
    Show on GitHub
  • getTitle() Extension method

    Retrieves the title of the font chooser dialog.

    Declaration

    Swift

    @inlinable
func getTitle() -> String!
    Show on GitHub
  • getUseFont() Extension method

    Returns whether the selected font is used in the label.

    Declaration

    Swift

    @inlinable
func getUseFont() -> Bool
    Show on GitHub
  • getUseSize() Extension method

    Returns whether the selected size is used in the label.

    Declaration

    Swift

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

    Sets whether the dialog should be modal.

    Declaration

    Swift

    @inlinable
func set(modal: Bool)
    Show on GitHub
  • set(title:) Extension method

    Sets the title for the font chooser dialog.

    Declaration

    Swift

    @inlinable
func set(title: UnsafePointer<CChar>!)
    Show on GitHub
  • set(useFont:) Extension method

    If use_font is true, the font name will be written using the selected font.

    Declaration

    Swift

    @inlinable
func set(useFont: Bool)
    Show on GitHub
  • set(useSize:) Extension method

    If use_size is true, the font name will be written using the selected size.

    Declaration

    Swift

    @inlinable
func set(useSize: Bool)
    Show on GitHub
  • modal Extension method

    Whether the font chooser dialog should be modal.

    Declaration

    Swift

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

    The title of the font chooser dialog.

    Declaration

    Swift

    @inlinable
var title: String! { get nonmutating set }
    Show on GitHub
  • useFont Extension method

    Returns whether the selected font is used in the label.

    Declaration

    Swift

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

    Returns whether the selected size is used in the label.

    Declaration

    Swift

    @inlinable
var useSize: Bool { get nonmutating set }
    Show on GitHub