class: StatusbarMeta

[413:14] static extends: object

Generated metadata helpers for Statusbar class surfaces.

Methods

• signals ()

  Returns signal metadata for Statusbar.

  • @r A list.

class: StatusbarTextpoppedCallback

[273:7] extends: object

Generated low-level callback wrapper for GIR callback text-popped.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• StatusbarTextpoppedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, context_id, text, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.

class: Statusbar

[36:7] extends: object

A GtkStatusbar widget is usually placed along the bottom of an application's main [class@Gtk.Window]. A GtkStatusBar may provide a regular commentary of the application's status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example). Status bars in GTK maintain a stack of messages. The message at the top of the each bar’s stack is the one that will currently be displayed. Any messages added to a statusbar’s stack must specify a context id that is used to uniquely identify the source of a message. This context id can be generated by [method@Gtk.Statusbar.get_context_id], given a message and the statusbar that it will be added to. Note that messages are stored in a stack, and when choosing which message to display, the stack structure is adhered to, regardless of the context identifier of a message. One could say that a statusbar maintains one stack of messages for display purposes, but allows multiple message producers to maintain sub-stacks of the messages they produced (via context ids). Status bars are created using [ctor@Gtk.Statusbar.new]. Messages are added to the bar’s stack with [method@Gtk.Statusbar.push]. The message at the top of the stack can be removed using [method@Gtk.Statusbar.pop]. A message can be removed from anywhere in the stack if its message id was recorded at the time it was added. This is done using [method@Gtk.Statusbar.remove]. ## CSS node GtkStatusbar has a single CSS node with name statusbar.

Members

• handleObj
• lib
• retainedCallbacks
• signalHandlerNames
• signalSetterHandlers

Methods

• Statusbar ()

  Creates a new GtkStatusbar ready for messages.

• toNativeHandle (Source)

  Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

  • @p Source is the raw handle, raw buffer, wrapper, or null.
  • @r A raw pointer carrier or null when no pointer is present.

• getLib ()

  Returns the opened native library for this generated wrapper.

  • @r The opened native library.

• handle ()

  Returns the wrapped NativeHandle.

  • @r The wrapped NativeHandle.

• isNull ()

  Returns true when the wrapped handle is null.

  • @r A bool.

• describe ()

  Returns a small string for debugging generated wrappers.

  • @r A string.

• asWidget ()

  Wraps this handle as Widget.

  • @r A Widget object.

• asAccessible ()

  Wraps this handle as Accessible.

  • @r A Accessible object.

• asBuildable ()

  Wraps this handle as Buildable.

  • @r A Buildable object.

• asConstraintTarget ()

  Wraps this handle as ConstraintTarget.

  • @r A ConstraintTarget object.

• connectSignal (string Name, CallbackObj)

  Connects one generated callback wrapper to a named signal.

  • @p Name is the signal name.
  • @p CallbackObj is the generated callback wrapper to connect.
  • @r The connected handler id.

• disconnectSignalHandler (int HandlerId)

  Disconnects one retained signal handler id.

  • @p HandlerId is the signal handler id to disconnect.
  • @r None.

• setOnTextpopped (callback Fn, UserData = null)

  Emitted whenever a new message is popped off a statusbar's stack.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Statusbar Self, int Context_id, string Text).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• setOnTextpushed (callback Fn, UserData = null)

  Emitted whenever a new message gets pushed onto a statusbar's stack.

  • @p Fn is the Aussom callback.
  • @p Fn is called with (Statusbar Self, int Context_id, string Text).
  • @p UserData is retained and passed through to the generated callback wrapper when provided.
  • @r The connected handler id.

• get_context_id (string context_description)

  Returns a new context identifier, given a description of the actual context. Note that the description is not shown in the UI.

  • @p context_description is textual description of what context the new message is being used in.

• pop (int context_id)

  Removes the first message in the GtkStatusbar’s stack with the given context id. Note that this may not change the displayed message, if the message at the top of the stack has a different context id.

  • @p context_id is a context identifier.
  • @r None.

• push (int context_id, string text)

  Pushes a new message onto a statusbar’s stack.

  • @p context_id is the message’s context id, as returned by gtk_statusbar_get_context_id().
  • @p text is the message to add to the statusbar.

• remove (int context_id, int message_id)

  Forces the removal of a message from a statusbar’s stack. The exact

  • @context_id and @message_id must be specified.
  • @p context_id is a context identifier.
  • @p message_id is a message identifier, as returned by [method@Gtk.Statusbar.push].
  • @r None.

• remove_all (int context_id)

  Forces the removal of all messages from a statusbar's stack with the exact @context_id.

  • @p context_id is a context identifier.
  • @r None.

class: StatusbarTextpushedCallback

[343:7] extends: object

Generated low-level callback wrapper for GIR callback text-pushed.

Members

• callbackObj
• userFn
• userData
• hasUserData

Methods

• StatusbarTextpushedCallback (callback Fn, UserData = null)

  Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

  • @p Fn is the Aussom callback implementation.
  • @p UserData is retained and passed through to Fn on each invocation when provided.

• trampoline (nativeSelf, context_id, text, nativeUserData)

  Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

• callback ()

  Returns the wrapped NativeCallback.

• handle ()

  Returns the callback as a NativeHandle.

• close ()

  Closes the underlying NativeCallback.

• isClosed ()

  Returns true when the callback has been closed.