Struct libadwaita::builders::AboutDialogBuilder

source ·

pub struct AboutDialogBuilder { /* private fields */ }

Available on crate feature v1_5 only.

Expand description

A builder-pattern type to construct AboutDialog objects.

Implementations§

source §

impl AboutDialogBuilder

source

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

The name of the application icon.

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

source

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

The name of the application.

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

source

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

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

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.

source

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

The copyright information.

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

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

source

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

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.

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

source

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

The debug information filename.

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

See debug-info.

source

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

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

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.

source

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

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

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

The URL for the application’s issue tracker.

The issue tracker link is displayed on the main page.

source

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

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.

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

source

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

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.

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

source

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

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 ()
Ordered list (<ol>), with list items (<li>)
Unordered list (<ul>), with list items (<li>)

Within paragraphs and list items, emphasis () 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.

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

source

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

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.

source

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

The URL of the application’s support page.

The support page link is displayed on the main page.

source

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

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

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.

source

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

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 AboutDialog::add_link().

source

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

Whether the dialog can be closed.

If set to FALSE, the close button, shortcuts and AdwDialogExt::close() will result in close-attempt being emitted instead, and bottom sheet close swipe will be disabled. AdwDialogExt::force_close() still works.

source

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

The child widget of the Dialog.

source

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

The height of the dialog’s contents.

Set it to -1 to reset it to the content’s natural height.

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

The width of the dialog’s contents.

Set it to -1 to reset it to the content’s natural width.

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

The default widget.

It’s activated when the user presses Enter.

source

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

The focus widget.

source

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

Whether to size content automatically.

If set to TRUE, always use the content’s natural size instead of content-width and content-height. If the content resizes, the dialog will immediately resize as well.

pub fn presentation_mode( self, presentation_mode: DialogPresentationMode, ) -> Self

The dialog’s presentation mode.

When set to ADW_DIALOG_AUTO, the dialog appears as a bottom sheet when the following condition is met: max-width: 450px or max-height: 360px, and as a floating window otherwise.

Set it to ADW_DIALOG_FLOATING or ADW_DIALOG_BOTTOM_SHEET to always present it a floating window or a bottom sheet respectively, regardless of available size.

Presentation mode does nothing for dialogs presented as a window.

source

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

The title of the dialog.

source

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

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

Whether the widget can receive pointer events.

source

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

A list of css classes applied to this widget.

source

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

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

The cursor used by @widget.

source

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

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

Whether this widget itself will accept the input focus.

source

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

How to distribute horizontal space if widget gets extra space.

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

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

Whether to expand horizontally.

source

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

Whether to use the hexpand property.

source

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

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

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

Margin on end of widget, horizontally.

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

source

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

Margin on start of widget, horizontally.

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

source

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

Margin on top side of widget.

source

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

The name of the widget.

source

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

The requested opacity of the widget.

source

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

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

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

source

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

Whether the widget responds to input.

source

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

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