Struct libpanel::DocumentWorkspace

pub struct DocumentWorkspace { /* private fields */ }

Properties

dock

Readable

grid

Readable

statusbar

Readable

Workspace

id

The “id” of the workspace.

This is generally used by applications to help destinguish between types of workspaces, particularly when saving session state.

Readable | Writeable

ApplicationWindow

content

The content widget.

This property should always be used instead of [propertyGtk:child].

Readable | Writeable

current-breakpoint

The current breakpoint.

Readable

dialogs

The open dialogs.

Readable

visible-dialog

The currently visible dialog

Readable

ApplicationWindow

show-menubar

If this property is true, the window will display a menubar unless it is shown by the desktop shell.

See [methodGtk.set_menubar].

If false, the window will not display a menubar, regardless of whether the desktop shell is showing it or not.

Readable | Writeable | Construct

Window

application

The GtkApplication associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to None.

Readable | Writeable

child

The child widget.

Readable | Writeable

decorated

Whether the window should have a frame (also known as decorations).

Readable | Writeable

default-height

The default height of the window.

Readable | Writeable

default-widget

The default widget.

Readable | Writeable

default-width

The default width of the window.

Readable | Writeable

deletable

Whether the window frame should have a close button.

Readable | Writeable

destroy-with-parent

If this window should be destroyed when the parent is destroyed.

Readable | Writeable

display

The display that will display this window.

Readable | Writeable

focus-visible

Whether ‘focus rectangles’ are currently visible in this window.

This property is maintained by GTK based on user input and should not be set by applications.

Readable | Writeable

focus-widget

The focus widget.

Readable | Writeable

fullscreened

Whether the window is fullscreen.

Setting this property is the equivalent of calling [methodGtk.fullscreen] or [methodGtk.unfullscreen]; either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

handle-menubar-accel

Whether the window frame should handle F10 for activating menubars.

Readable | Writeable

hide-on-close

If this window should be hidden when the users clicks the close button.

Readable | Writeable

icon-name

Specifies the name of the themed icon to use as the window icon.

See [classGtk] for more details.

Readable | Writeable

is-active

Whether the toplevel is the currently active window.

Readable

maximized

Whether the window is maximized.

Setting this property is the equivalent of calling [methodGtk.maximize] or [methodGtk.unmaximize]; either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

mnemonics-visible

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

Readable | Writeable

modal

If true, the window is modal.

Readable | Writeable

resizable

If true, users can resize the window.

Readable | Writeable

startup-id

A write-only property for setting window’s startup notification identifier.

Writeable

suspended

Whether the window is suspended.

See [methodGtk.is_suspended] for details about what suspended means.

Readable

title

The title of the window.

Readable | Writeable

titlebar

The titlebar widget.

Readable | Writeable

transient-for

The transient parent of the window.

Readable | Writeable | Construct

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on widget.

A value of true indicates that widget can have a tooltip, in this case the widget will be queried using [signalGtk::query-tooltip] to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.set_size_request] for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.set_size_request] for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.set_size_request] for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [methodGtk.set_size_request] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The GtkRoot widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see [methodGtk.set_markup].

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: [propertyGtk:has-tooltip] will automatically be set to true and there will be taken care of [signalGtk::query-tooltip] in the default signal handler.

Note that if both [propertyGtk:tooltip-text] and [propertyGtk:tooltip-markup] are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see [methodGtk.set_text].

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: [propertyGtk:has-tooltip] will automatically be set to true and there will be taken care of [signalGtk::query-tooltip] in the default signal handler.

Note that if both [propertyGtk:tooltip-text] and [propertyGtk:tooltip-markup] are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

add-widget

This signal is used to add a Widget to the document workspace, generally in the document grid.

create-frame

Creates a new Frame to be added to the document grid.

Window

activate-default

Emitted when the user activates the default widget of window.

This is a keybinding signal.

The keybindings for this signal are all forms of the <kbd>Enter</kbd> key.

Action

activate-focus

Emitted when the user activates the currently focused widget of window.

This is a keybinding signal.

The default binding for this signal is <kbd>␣</kbd>.

Action

close-request

Emitted when the user clicks on the close button of the window.

enable-debugging

Emitted when the user enables or disables interactive debugging.

When toggle is true, interactive debugging is toggled on or off, when it is false, the debugger will be pointed at the widget under the pointer.

This is a keybinding signal.

The default bindings for this signal are <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>I</kbd> and <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd>.

Action

keys-changed

emitted when the set of accelerators or mnemonics that are associated with window changes.

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See [methodGtk.keynav_failed] for details.

map

Emitted when widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with [propertyGtk:visible]) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of [signalGtk::unmap].

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates widget if group_cycling is false, or just makes widget grab focus if group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are <kbd>Tab</kbd> to move forward, and <kbd>Shift</kbd>+<kbd>Tab</kbd> to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the [propertyGtk:has-tooltip] property is true and the hover timeout has expired with the cursor hovering “above” widget; or emitted when widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for widget. If this is the case true should be returned, false otherwise. Note that if keyboard_mode is true, the values of x and y are undefined and should not be used.

The signal handler is free to manipulate tooltip with the therefore destined function calls.

realize

Emitted when widget is associated with a GdkSurface.

This means that [methodGtk.realize] has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when widget is shown.

state-flags-changed

Emitted when the widget state changes.

See [methodGtk.get_state_flags].

unmap

Emitted when widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the GdkSurface associated with widget is destroyed.

This means that [methodGtk.unrealize] has been called or the widget has been unmapped (that is, it is going to be hidden).

ActionGroup

action-added

Signals that a new action was just added to the group.

This signal is emitted after the action has been added and is now visible.

Detailed

action-enabled-changed

Signals that the enabled status of the named action has changed.

Detailed

action-removed

Signals that an action is just about to be removed from the group.

This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

Detailed

action-state-changed

Signals that the state of the named action has changed.

Detailed

Implements

DocumentWorkspaceExt, WorkspaceExt, adw::prelude::ApplicationWindowExt, gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, gio::prelude::ActionGroupExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl DocumentWorkspace

pub const NONE: Option<&'static DocumentWorkspace> = None

pub fn new() -> DocumentWorkspace

Creates a new DocumentWorkspace.

Returns

a DocumentWorkspace

pub fn builder() -> DocumentWorkspaceBuilder

Creates a new builder-pattern struct instance to construct DocumentWorkspace objects.

This method returns an instance of DocumentWorkspaceBuilder which can be used to create DocumentWorkspace objects.

Trait Implementations

impl Clone for DocumentWorkspace

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocumentWorkspace

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DocumentWorkspace

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for DocumentWorkspace

type ParamSpec = ParamSpecObject

type SetValue = DocumentWorkspace

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, DocumentWorkspace>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DocumentWorkspace

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: DocumentWorkspaceImpl> IsSubclassable<T> for DocumentWorkspace

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for DocumentWorkspace

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for DocumentWorkspace

type Parent = Workspace

impl<OT: ObjectType> PartialEq<OT> for DocumentWorkspace

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for DocumentWorkspace

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DocumentWorkspace

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DocumentWorkspace

impl IsA<Accessible> for DocumentWorkspace

impl IsA<ActionGroup> for DocumentWorkspace

impl IsA<ApplicationWindow> for DocumentWorkspace

impl IsA<Buildable> for DocumentWorkspace

impl IsA<ConstraintTarget> for DocumentWorkspace

impl IsA<Widget> for DocumentWorkspace

impl IsA<Workspace> for DocumentWorkspace