libadwaita::builders

Struct AboutWindowBuilder

source
pub struct AboutWindowBuilder { /* private fields */ }
๐Ÿ‘ŽDeprecated: Since 1.6
Available on crate feature v1_2 only.
Expand description

A builder-pattern type to construct AboutWindow objects.

Implementationsยง

sourceยง

impl AboutWindowBuilder

source

pub fn application_icon(self, application_icon: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The name of the application icon.

The icon is displayed at the top of the main page. Use AboutDialog.

source

pub fn application_name(self, application_name: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The name of the application.

The name is displayed at the top of the main page. Use AboutDialog.

source

pub fn artists(self, artists: impl Into<StrV>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The list of artists of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

source

pub fn comments(self, comments: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The comments about the application.

Comments will be shown on the Details page, above links.

Unlike [comments][struct@crate::Gtk::AboutDialog#comments], this string can be long and detailed. It can also contain links and Pango markup. Use AboutDialog.

source

pub fn copyright(self, copyright: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The copyright information.

This should be a short string of one or two lines, for example: ยฉ 2022 Example.

The copyright information will be displayed on the Legal page, above the application license.

AboutWindow::add_legal_section() can be used to add copyright information for the application dependencies or other components. Use AboutDialog.

source

pub fn debug_info(self, debug_info: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The debug information.

Debug information will be shown on the Troubleshooting page. Itโ€™s intended to be attached to issue reports when reporting issues against the application.

AboutWindow provides a quick way to save debug information to a file. When saving, debug-info-filename would be used as the suggested filename.

Debug information cannot contain markup or links. Use AboutDialog.

source

pub fn debug_info_filename( self, debug_info_filename: impl Into<GString>, ) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The debug information filename.

It will be used as the suggested filename when saving debug information to a file.

See debug-info. Use AboutDialog.

source

pub fn designers(self, designers: impl Into<StrV>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The list of designers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

source

pub fn developer_name(self, developer_name: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The developer name.

The developer name is displayed on the main page, under the application name.

If the application is developed by multiple people, the developer name can be set to values like โ€œAppName teamโ€, โ€œAppName developersโ€ or โ€œThe AppName projectโ€, and the individual contributors can be listed on the Credits page, with developers and related properties. Use AboutDialog.

source

pub fn developers(self, developers: impl Into<StrV>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The list of developers of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

source

pub fn documenters(self, documenters: impl Into<StrV>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The list of documenters of the application.

It will be displayed on the Credits page.

Each name may contain email addresses and URLs, see the introduction for more details.

See also:

source

pub fn issue_url(self, issue_url: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The URL for the applicationโ€™s issue tracker.

The issue tracker link is displayed on the main page. Use AboutDialog.

source

pub fn license(self, license: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The license text.

This can be used to set a custom text for the license if it canโ€™t be set via license-type.

When set, license-type will be set to GTK_LICENSE_CUSTOM.

The license text will be displayed on the Legal page, below the copyright information.

License text can contain Pango markup and links.

AboutWindow::add_legal_section() can be used to add license information for the application dependencies or other components. Use AboutDialog.

source

pub fn license_type(self, license_type: License) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The license type.

Allows to set the applicationโ€™s license froma list of known licenses.

If the applicationโ€™s license is not in the list, license can be used instead. The license type will be automatically set to GTK_LICENSE_CUSTOM in that case.

If set to GTK_LICENSE_UNKNOWN, no information will be displayed.

If the license type is different from GTK_LICENSE_CUSTOM. license will be cleared out.

The license description will be displayed on the Legal page, below the copyright information.

AboutWindow::add_legal_section() can be used to add license information for the application dependencies or other components. Use AboutDialog.

source

pub fn release_notes(self, release_notes: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The release notes of the application.

Release notes are displayed on the the Whatโ€™s New page.

Release notes are formatted the same way as AppStream descriptions.

The supported formatting options are:

  • Paragraph (<p>)
  • Ordered list (<ol>), with list items (<li>)
  • Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis (<em>) and inline code (<code>) text styles are supported. The emphasis is rendered in italic, while inline code is shown in a monospaced font.

Any text outside paragraphs or list items is ignored.

Nested lists are not supported.

AboutWindow displays the version above the release notes. If set, the release-notes-version of the property will be used as the version; otherwise, version is used. Use AboutDialog.

source

pub fn release_notes_version( self, release_notes_version: impl Into<GString>, ) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The version described by the applicationโ€™s release notes.

The release notes version is displayed on the Whatโ€™s New page, above the release notes.

If not set, version will be used instead.

For example, an application with the current version 2.0.2 might want to keep the release notes from 2.0.0, and set the release notes version accordingly.

See release-notes. Use AboutDialog.

source

pub fn support_url(self, support_url: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The URL of the applicationโ€™s support page.

The support page link is displayed on the main page. Use AboutDialog.

source

pub fn translator_credits(self, translator_credits: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The translator credits string.

It will be displayed on the Credits page.

This string should be "translator-credits" or "translator_credits" and should be marked as translatable.

The string may contain email addresses and URLs, see the introduction for more details.

See also:

source

pub fn version(self, version: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The version of the application.

The version is displayed on the main page.

If release-notes-version is not set, the version will also be displayed above the release notes on the Whatโ€™s New page. Use AboutDialog.

source

pub fn website(self, website: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The URL of the applicationโ€™s website.

Website is displayed on the Details page, below comments, or on the main page if the Details page doesnโ€™t have any other content.

Applications can add other links below, see AboutWindow::add_link(). Use AboutDialog.

source

pub fn content(self, content: &impl IsA<Widget>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The content widget.

This property should always be used instead of child.

source

pub fn application(self, application: &impl IsA<Application>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The gtk::Application 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.

source

pub fn decorated(self, decorated: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

source

pub fn default_height(self, default_height: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The default height of the window.

source

pub fn default_widget(self, default_widget: &impl IsA<Widget>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The default widget.

source

pub fn default_width(self, default_width: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The default width of the window.

source

pub fn deletable(self, deletable: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether the window frame should have a close button.

source

pub fn destroy_with_parent(self, destroy_with_parent: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

source

pub fn display(self, display: &Display) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The display that will display this window.

source

pub fn focus_visible(self, focus_visible: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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.

source

pub fn focus_widget(self, focus_widget: &impl IsA<Widget>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The focus widget.

source

pub fn fullscreened(self, fullscreened: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether the window is fullscreen.

Setting this property is the equivalent of calling [GtkWindowExtManual::fullscreen()][crate::gtk::prelude::GtkWindowExtManual::fullscreen()] or [GtkWindowExtManual::unfullscreen()][crate::gtk::prelude::GtkWindowExtManual::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.

source

pub fn handle_menubar_accel(self, handle_menubar_accel: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6
Available on crate feature gtk_v4_2 only.

Whether the window frame should handle F10 for activating menubars.

source

pub fn hide_on_close(self, hide_on_close: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

source

pub fn icon_name(self, icon_name: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

See Gtk::IconTheme for more details.

source

pub fn maximized(self, maximized: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether the window is maximized.

Setting this property is the equivalent of calling [GtkWindowExtManual::maximize()][crate::gtk::prelude::GtkWindowExtManual::maximize()] or [GtkWindowExtManual::unmaximize()][crate::gtk::prelude::GtkWindowExtManual::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.

source

pub fn mnemonics_visible(self, mnemonics_visible: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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.

source

pub fn modal(self, modal: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

If true, the window is modal.

source

pub fn resizable(self, resizable: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

If true, users can resize the window.

source

pub fn startup_id(self, startup_id: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

A write-only property for setting windowโ€™s startup notification identifier.

source

pub fn title(self, title: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The title of the window.

source

pub fn titlebar(self, titlebar: &impl IsA<Widget>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6
Available on crate feature gtk_v4_6 only.

The titlebar widget.

source

pub fn transient_for(self, transient_for: &impl IsA<Window>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The transient parent of the window.

source

pub fn can_focus(self, can_focus: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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.

source

pub fn can_target(self, can_target: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether the widget can receive pointer events.

source

pub fn css_classes(self, css_classes: impl Into<StrV>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

A list of css classes applied to this widget.

source

pub fn css_name(self, css_name: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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.

source

pub fn cursor(self, cursor: &Cursor) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The cursor used by @widget.

source

pub fn focus_on_click(self, focus_on_click: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

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

source

pub fn focusable(self, focusable: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether this widget itself will accept the input focus.

source

pub fn halign(self, halign: Align) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

How to distribute horizontal space if widget gets extra space.

source

pub fn has_tooltip(self, has_tooltip: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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 query-tooltip to determine whether it will provide a tooltip or not.

source

pub fn height_request(self, height_request: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Override for height request of the widget.

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

source

pub fn hexpand(self, hexpand: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether to expand horizontally.

source

pub fn hexpand_set(self, hexpand_set: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether to use the hexpand property.

source

pub fn layout_manager(self, layout_manager: &impl IsA<LayoutManager>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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.

source

pub fn margin_bottom(self, margin_bottom: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

source

pub fn margin_end(self, margin_end: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

source

pub fn margin_start(self, margin_start: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

source

pub fn margin_top(self, margin_top: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

source

pub fn name(self, name: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The name of the widget.

source

pub fn opacity(self, opacity: f64) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

The requested opacity of the widget.

source

pub fn overflow(self, overflow: Overflow) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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.

source

pub fn receives_default(self, receives_default: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

source

pub fn sensitive(self, sensitive: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether the widget responds to input.

source

pub fn tooltip_markup(self, tooltip_markup: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

Also see Gtk::Tooltip::set_markup().

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

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

source

pub fn tooltip_text(self, tooltip_text: impl Into<GString>) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

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

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

source

pub fn valign(self, valign: Align) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

How to distribute vertical space if widget gets extra space.

source

pub fn vexpand(self, vexpand: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether to expand vertically.

source

pub fn vexpand_set(self, vexpand_set: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether to use the vexpand property.

source

pub fn visible(self, visible: bool) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Whether the widget is visible.

source

pub fn width_request(self, width_request: i32) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

Override for width request of the widget.

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

source

pub fn accessible_role(self, accessible_role: AccessibleRole) -> Self

๐Ÿ‘ŽDeprecated: Since 1.6

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

The accessible role cannot be changed once set.

source

pub fn build(self) -> AboutWindow

๐Ÿ‘ŽDeprecated: Since 1.6

Build the AboutWindow.

Auto Trait Implementationsยง

Blanket Implementationsยง

sourceยง

impl<T> Any for T
where T: 'static + ?Sized,

sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
sourceยง

impl<T> From<T> for T

sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
sourceยง

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.