Skip to main content

Interface: AdwAboutDialogProps

Defined in: packages/react/src/generated/jsx.ts:483

Props for the AdwAboutDialog widget.

Extends​

Properties​

accessibleActiveDescendant?​

optional accessibleActiveDescendant: Widget

Defined in: packages/react/src/jsx.ts:1175

Inherited from​

AdwDialogProps.accessibleActiveDescendant


accessibleAutocomplete?​

optional accessibleAutocomplete: AccessibleAutocomplete

Defined in: packages/react/src/jsx.ts:1144

Inherited from​

AdwDialogProps.accessibleAutocomplete


accessibleBusy?​

optional accessibleBusy: boolean

Defined in: packages/react/src/jsx.ts:1165

Inherited from​

AdwDialogProps.accessibleBusy


accessibleChecked?​

optional accessibleChecked: AccessibleTristate

Defined in: packages/react/src/jsx.ts:1166

Inherited from​

AdwDialogProps.accessibleChecked


accessibleColCount?​

optional accessibleColCount: number

Defined in: packages/react/src/jsx.ts:1176

Inherited from​

AdwDialogProps.accessibleColCount


accessibleColIndex?​

optional accessibleColIndex: number

Defined in: packages/react/src/jsx.ts:1177

Inherited from​

AdwDialogProps.accessibleColIndex


accessibleColIndexText?​

optional accessibleColIndexText: string

Defined in: packages/react/src/jsx.ts:1178

Inherited from​

AdwDialogProps.accessibleColIndexText


accessibleColSpan?​

optional accessibleColSpan: number

Defined in: packages/react/src/jsx.ts:1179

Inherited from​

AdwDialogProps.accessibleColSpan


accessibleControls?​

optional accessibleControls: Widget[]

Defined in: packages/react/src/jsx.ts:1180

Inherited from​

AdwDialogProps.accessibleControls


accessibleDescribedBy?​

optional accessibleDescribedBy: Widget[]

Defined in: packages/react/src/jsx.ts:1181

Inherited from​

AdwDialogProps.accessibleDescribedBy


accessibleDescription?​

optional accessibleDescription: string

Defined in: packages/react/src/jsx.ts:1145

Inherited from​

AdwDialogProps.accessibleDescription


accessibleDetails?​

optional accessibleDetails: Widget[]

Defined in: packages/react/src/jsx.ts:1182

Inherited from​

AdwDialogProps.accessibleDetails


accessibleDisabled?​

optional accessibleDisabled: boolean

Defined in: packages/react/src/jsx.ts:1167

Inherited from​

AdwDialogProps.accessibleDisabled


accessibleErrorMessage?​

optional accessibleErrorMessage: Widget[]

Defined in: packages/react/src/jsx.ts:1183

Inherited from​

AdwDialogProps.accessibleErrorMessage


accessibleExpanded?​

optional accessibleExpanded: boolean

Defined in: packages/react/src/jsx.ts:1168

Inherited from​

AdwDialogProps.accessibleExpanded


accessibleFlowTo?​

optional accessibleFlowTo: Widget[]

Defined in: packages/react/src/jsx.ts:1184

Inherited from​

AdwDialogProps.accessibleFlowTo


accessibleHasPopup?​

optional accessibleHasPopup: boolean

Defined in: packages/react/src/jsx.ts:1146

Inherited from​

AdwDialogProps.accessibleHasPopup


accessibleHelpText?​

optional accessibleHelpText: string

Defined in: packages/react/src/jsx.ts:1163

Inherited from​

AdwDialogProps.accessibleHelpText


accessibleHidden?​

optional accessibleHidden: boolean

Defined in: packages/react/src/jsx.ts:1169

Inherited from​

AdwDialogProps.accessibleHidden


accessibleInvalid?​

optional accessibleInvalid: AccessibleInvalidState

Defined in: packages/react/src/jsx.ts:1170

Inherited from​

AdwDialogProps.accessibleInvalid


accessibleKeyShortcuts?​

optional accessibleKeyShortcuts: string

Defined in: packages/react/src/jsx.ts:1147

Inherited from​

AdwDialogProps.accessibleKeyShortcuts


accessibleLabel?​

optional accessibleLabel: string

Defined in: packages/react/src/jsx.ts:1148

Inherited from​

AdwDialogProps.accessibleLabel


accessibleLabelledBy?​

optional accessibleLabelledBy: Widget[]

Defined in: packages/react/src/jsx.ts:1185

Inherited from​

AdwDialogProps.accessibleLabelledBy


accessibleLevel?​

optional accessibleLevel: number

Defined in: packages/react/src/jsx.ts:1149

Inherited from​

AdwDialogProps.accessibleLevel


accessibleModal?​

optional accessibleModal: boolean

Defined in: packages/react/src/jsx.ts:1150

Inherited from​

AdwDialogProps.accessibleModal


accessibleMultiLine?​

optional accessibleMultiLine: boolean

Defined in: packages/react/src/jsx.ts:1151

Inherited from​

AdwDialogProps.accessibleMultiLine


accessibleMultiSelectable?​

optional accessibleMultiSelectable: boolean

Defined in: packages/react/src/jsx.ts:1152

Inherited from​

AdwDialogProps.accessibleMultiSelectable


accessibleOrientation?​

optional accessibleOrientation: Orientation

Defined in: packages/react/src/jsx.ts:1153

Inherited from​

AdwDialogProps.accessibleOrientation


accessibleOwns?​

optional accessibleOwns: Widget[]

Defined in: packages/react/src/jsx.ts:1186

Inherited from​

AdwDialogProps.accessibleOwns


accessiblePlaceholder?​

optional accessiblePlaceholder: string

Defined in: packages/react/src/jsx.ts:1154

Inherited from​

AdwDialogProps.accessiblePlaceholder


accessiblePosInSet?​

optional accessiblePosInSet: number

Defined in: packages/react/src/jsx.ts:1187

Inherited from​

AdwDialogProps.accessiblePosInSet


accessiblePressed?​

optional accessiblePressed: AccessibleTristate

Defined in: packages/react/src/jsx.ts:1171

Inherited from​

AdwDialogProps.accessiblePressed


accessibleReadOnly?​

optional accessibleReadOnly: boolean

Defined in: packages/react/src/jsx.ts:1155

Inherited from​

AdwDialogProps.accessibleReadOnly


accessibleRequired?​

optional accessibleRequired: boolean

Defined in: packages/react/src/jsx.ts:1156

Inherited from​

AdwDialogProps.accessibleRequired


accessibleRole?​

optional accessibleRole: AccessibleRole

Defined in: packages/react/src/generated/jsx.ts:187

The accessible role of the given GtkAccessible implementation.

The accessible role cannot be changed once set.

Inherited from​

AdwDialogProps.accessibleRole


accessibleRoleDescription?​

optional accessibleRoleDescription: string

Defined in: packages/react/src/jsx.ts:1157

Inherited from​

AdwDialogProps.accessibleRoleDescription


accessibleRowCount?​

optional accessibleRowCount: number

Defined in: packages/react/src/jsx.ts:1188

Inherited from​

AdwDialogProps.accessibleRowCount


accessibleRowIndex?​

optional accessibleRowIndex: number

Defined in: packages/react/src/jsx.ts:1189

Inherited from​

AdwDialogProps.accessibleRowIndex


accessibleRowIndexText?​

optional accessibleRowIndexText: string

Defined in: packages/react/src/jsx.ts:1190

Inherited from​

AdwDialogProps.accessibleRowIndexText


accessibleRowSpan?​

optional accessibleRowSpan: number

Defined in: packages/react/src/jsx.ts:1191

Inherited from​

AdwDialogProps.accessibleRowSpan


accessibleSelected?​

optional accessibleSelected: boolean

Defined in: packages/react/src/jsx.ts:1172

Inherited from​

AdwDialogProps.accessibleSelected


accessibleSetSize?​

optional accessibleSetSize: number

Defined in: packages/react/src/jsx.ts:1192

Inherited from​

AdwDialogProps.accessibleSetSize


accessibleSort?​

optional accessibleSort: AccessibleSort

Defined in: packages/react/src/jsx.ts:1158

Inherited from​

AdwDialogProps.accessibleSort


accessibleValueMax?​

optional accessibleValueMax: number

Defined in: packages/react/src/jsx.ts:1159

Inherited from​

AdwDialogProps.accessibleValueMax


accessibleValueMin?​

optional accessibleValueMin: number

Defined in: packages/react/src/jsx.ts:1160

Inherited from​

AdwDialogProps.accessibleValueMin


accessibleValueNow?​

optional accessibleValueNow: number

Defined in: packages/react/src/jsx.ts:1161

Inherited from​

AdwDialogProps.accessibleValueNow


accessibleValueText?​

optional accessibleValueText: string

Defined in: packages/react/src/jsx.ts:1162

Inherited from​

AdwDialogProps.accessibleValueText


accessibleVisited?​

optional accessibleVisited: boolean

Defined in: packages/react/src/jsx.ts:1173

Inherited from​

AdwDialogProps.accessibleVisited


applicationIcon?​

optional applicationIcon: string

Defined in: packages/react/src/generated/jsx.ts:489

The name of the application icon.

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


applicationName?​

optional applicationName: string

Defined in: packages/react/src/generated/jsx.ts:495

The name of the application.

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


artists?​

optional artists: string[] | null

Defined in: packages/react/src/generated/jsx.ts:513

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:

  • AdwAboutDialog.developers
  • AdwAboutDialog.designers
  • AdwAboutDialog.documenters
  • AdwAboutDialog.translator-credits
  • AboutDialogadd_credit_section
  • AboutDialogadd_acknowledgement_section

canClose?​

optional canClose: boolean

Defined in: packages/react/src/generated/jsx.ts:2618

Whether the dialog can be closed.

If set to FALSE, the close button, shortcuts and Dialogclose will result in AdwDialog.:close-attempt being emitted instead, and bottom sheet close swipe will be disabled. Dialogforce_close still works.

Inherited from​

AdwDialogProps.canClose


canFocus?​

optional canFocus: boolean

Defined in: packages/react/src/generated/jsx.ts:24

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.

Inherited from​

AdwDialogProps.canFocus


canTarget?​

optional canTarget: boolean

Defined in: packages/react/src/generated/jsx.ts:26

Whether the widget can receive pointer events.

Inherited from​

AdwDialogProps.canTarget


child?​

optional child: Widget | null

Defined in: packages/react/src/generated/jsx.ts:2620

The child widget of the AdwDialog.

Inherited from​

AdwPreferencesDialogProps.child


children?​

optional children: ReactNode

Defined in: packages/react/src/generated/jsx.ts:314

Children elements (child widgets or event controllers).

Inherited from​

AdwDialogProps.children


comments?​

optional comments: string

Defined in: packages/react/src/generated/jsx.ts:522

The comments about the application.

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

Unlike AboutDialog.comments, this string can be long and detailed. It can also contain links and Pango markup.


contentHeight?​

optional contentHeight: number

Defined in: packages/react/src/generated/jsx.ts:2628

The height of the dialog's contents.

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

See also: Window.default-height

Inherited from​

AdwDialogProps.contentHeight


contentWidth?​

optional contentWidth: number

Defined in: packages/react/src/generated/jsx.ts:2636

The width of the dialog's contents.

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

See also: Window.default-width

Inherited from​

AdwDialogProps.contentWidth


optional copyright: string

Defined in: packages/react/src/generated/jsx.ts:535

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.

AboutDialogadd_legal_section can be used to add copyright information for the application dependencies or other components.


cssClasses?​

optional cssClasses: string[]

Defined in: packages/react/src/generated/jsx.ts:28

A list of css classes applied to this widget.

Inherited from​

AdwDialogProps.cssClasses


cssName?​

optional cssName: string

Defined in: packages/react/src/generated/jsx.ts:35

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.

Inherited from​

AdwDialogProps.cssName


cursor?​

optional cursor: Cursor | null

Defined in: packages/react/src/generated/jsx.ts:37

The cursor used by widget.

Inherited from​

AdwDialogProps.cursor


debugInfo?​

optional debugInfo: string

Defined in: packages/react/src/generated/jsx.ts:549

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.

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

Debug information cannot contain markup or links.


debugInfoFilename?​

optional debugInfoFilename: string

Defined in: packages/react/src/generated/jsx.ts:558

The debug information filename.

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

See AdwAboutDialog.debug-info.


defaultWidget?​

optional defaultWidget: Widget | null

Defined in: packages/react/src/generated/jsx.ts:2642

The default widget.

It's activated when the user presses Enter.

Inherited from​

AdwPreferencesDialogProps.defaultWidget


designers?​

optional designers: string[] | null

Defined in: packages/react/src/generated/jsx.ts:576

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:

  • AdwAboutDialog.developers
  • AdwAboutDialog.artists
  • AdwAboutDialog.documenters
  • AdwAboutDialog.translator-credits
  • AboutDialogadd_credit_section
  • AboutDialogadd_acknowledgement_section

developerName?​

optional developerName: string

Defined in: packages/react/src/generated/jsx.ts:589

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 AdwAboutDialog.developers and related properties.


developers?​

optional developers: string[] | null

Defined in: packages/react/src/generated/jsx.ts:607

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:

  • AdwAboutDialog.designers
  • AdwAboutDialog.artists
  • AdwAboutDialog.documenters
  • AdwAboutDialog.translator-credits
  • AboutDialogadd_credit_section
  • AboutDialogadd_acknowledgement_section

documenters?​

optional documenters: string[] | null

Defined in: packages/react/src/generated/jsx.ts:625

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:

  • AdwAboutDialog.developers
  • AdwAboutDialog.designers
  • AdwAboutDialog.artists
  • AdwAboutDialog.translator-credits
  • AboutDialogadd_credit_section
  • AboutDialogadd_acknowledgement_section

focusable?​

optional focusable: boolean

Defined in: packages/react/src/generated/jsx.ts:45

Whether this widget itself will accept the input focus.

Inherited from​

AdwDialogProps.focusable


focusOnClick?​

optional focusOnClick: boolean

Defined in: packages/react/src/generated/jsx.ts:43

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

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

Inherited from​

AdwDialogProps.focusOnClick


focusWidget?​

optional focusWidget: Widget | null

Defined in: packages/react/src/generated/jsx.ts:2644

The focus widget.

Inherited from​

AdwPreferencesDialogProps.focusWidget


followsContentSize?​

optional followsContentSize: boolean

Defined in: packages/react/src/generated/jsx.ts:2654

Whether to size content automatically.

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

See also: Window.resizable

Inherited from​

AdwDialogProps.followsContentSize


halign?​

optional halign: Align

Defined in: packages/react/src/generated/jsx.ts:47

How to distribute horizontal space if widget gets extra space.

Inherited from​

AdwDialogProps.halign


hasTooltip?​

optional hasTooltip: boolean

Defined in: packages/react/src/generated/jsx.ts:56

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

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

Inherited from​

AdwDialogProps.hasTooltip


heightRequest?​

optional heightRequest: number

Defined in: packages/react/src/generated/jsx.ts:62

Overrides for height request of the widget.

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

Inherited from​

AdwDialogProps.heightRequest


hexpand?​

optional hexpand: boolean

Defined in: packages/react/src/generated/jsx.ts:64

Whether to expand horizontally.

Inherited from​

AdwDialogProps.hexpand


hexpandSet?​

optional hexpandSet: boolean

Defined in: packages/react/src/generated/jsx.ts:66

Whether to use the hexpand property.

Inherited from​

AdwDialogProps.hexpandSet


issueUrl?​

optional issueUrl: string

Defined in: packages/react/src/generated/jsx.ts:631

The URL for the application's issue tracker.

The issue tracker link is displayed on the main page.


layoutManager?​

optional layoutManager: LayoutManager | null

Defined in: packages/react/src/generated/jsx.ts:74

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

Inherited from​

AdwDialogProps.layoutManager


license?​

optional license: string

Defined in: packages/react/src/generated/jsx.ts:649

The license text.

This can be used to set a custom text for the license if it can't be set via AdwAboutDialog.license-type.

When set, AdwAboutDialog.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.

AboutDialogadd_legal_section can be used to add license information for the application dependencies or other components.


licenseType?​

optional licenseType: License

Defined in: packages/react/src/generated/jsx.ts:670

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, AdwAboutDialog.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. AdwAboutDialog.license will be cleared out.

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

AboutDialogadd_legal_section can be used to add license information for the application dependencies or other components.


limitEvents?​

optional limitEvents: boolean

Defined in: packages/react/src/generated/jsx.ts:83

Makes this widget act like a modal dialog, with respect to event delivery.

Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See EventController.set_propagation_limit.

Inherited from​

AdwDialogProps.limitEvents


marginBottom?​

optional marginBottom: number

Defined in: packages/react/src/generated/jsx.ts:91

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 Widget.set_size_request for example.

Inherited from​

AdwDialogProps.marginBottom


marginEnd?​

optional marginEnd: number

Defined in: packages/react/src/generated/jsx.ts:102

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 Widget.set_size_request for example.

Inherited from​

AdwDialogProps.marginEnd


marginStart?​

optional marginStart: number

Defined in: packages/react/src/generated/jsx.ts:113

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 Widget.set_size_request for example.

Inherited from​

AdwDialogProps.marginStart


marginTop?​

optional marginTop: number

Defined in: packages/react/src/generated/jsx.ts:121

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 Widget.set_size_request for example.

Inherited from​

AdwDialogProps.marginTop


name?​

optional name: string

Defined in: packages/react/src/generated/jsx.ts:123

The name of the widget.

Inherited from​

AdwDialogProps.name


optional onActivateLink: (uri, self) => boolean | null

Defined in: packages/react/src/generated/jsx.ts:764

Emitted when a URL is activated.

Applications may connect to it to override the default behavior, which is to call show_uri.


onCloseAttempt?​

optional onCloseAttempt: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:2676

Emitted when the close button or shortcut is used, or Dialogclose is called while AdwDialog.can-close is set to FALSE.

Inherited from​

AdwDialogProps.onCloseAttempt


onClosed?​

optional onClosed: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:2678

Emitted when the dialog is successfully closed.

Inherited from​

AdwDialogProps.onClosed


onDestroy?​

optional onDestroy: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:196

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.

Inherited from​

AdwDialogProps.onDestroy


onDirectionChanged?​

optional onDirectionChanged: (previousDirection, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:198

Emitted when the text direction of a widget changes.

Inherited from​

AdwDialogProps.onDirectionChanged


onHide?​

optional onHide: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:200

Emitted when widget is hidden.

Inherited from​

AdwDialogProps.onHide


onKeynavFailed?​

optional onKeynavFailed: (direction, self) => boolean | null

Defined in: packages/react/src/generated/jsx.ts:206

Emitted if keyboard navigation fails.

See Widget.keynav_failed for details.

Inherited from​

AdwDialogProps.onKeynavFailed


onMap?​

optional onMap: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:218

Emitted when widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with Widget.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 Widget.:unmap.

Inherited from​

AdwDialogProps.onMap


onMnemonicActivate?​

optional onMnemonicActivate: (groupCycling, self) => boolean | null

Defined in: packages/react/src/generated/jsx.ts:225

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.

Inherited from​

AdwDialogProps.onMnemonicActivate


onMoveFocus?​

optional onMoveFocus: (direction, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:234

Emitted when the focus is moved.

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

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

Inherited from​

AdwDialogProps.onMoveFocus


onNotify?​

optional onNotify: (pspec, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:312

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:

|[ 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]GObjectParamSpec#parameter-names as detail strings for the notify signal.

Inherited from​

AdwDialogProps.onNotify


onQueryTooltip?​

optional onQueryTooltip: (x, y, keyboardMode, tooltip, self) => boolean | null

Defined in: packages/react/src/generated/jsx.ts:250

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

This happens when the Widget.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.

Inherited from​

AdwDialogProps.onQueryTooltip


onRealize?​

optional onRealize: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:259

Emitted when widget is associated with a GdkSurface.

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

Inherited from​

AdwDialogProps.onRealize


onShow?​

optional onShow: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:261

Emitted when widget is shown.

Inherited from​

AdwDialogProps.onShow


onStateFlagsChanged?​

optional onStateFlagsChanged: (flags, self) => void | null

Defined in: packages/react/src/generated/jsx.ts:267

Emitted when the widget state changes.

See Widget.get_state_flags.

Inherited from​

AdwDialogProps.onStateFlagsChanged


onUnmap?​

optional onUnmap: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:277

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.

Inherited from​

AdwDialogProps.onUnmap


onUnrealize?​

optional onUnrealize: (self) => void | null

Defined in: packages/react/src/generated/jsx.ts:284

Emitted when the GdkSurface associated with widget is destroyed.

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

Inherited from​

AdwDialogProps.onUnrealize


opacity?​

optional opacity: number

Defined in: packages/react/src/generated/jsx.ts:125

The requested opacity of the widget.

Inherited from​

AdwDialogProps.opacity


overflow?​

optional overflow: Overflow

Defined in: packages/react/src/generated/jsx.ts:132

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.

Inherited from​

AdwDialogProps.overflow


presentationMode?​

optional presentationMode: DialogPresentationMode

Defined in: packages/react/src/generated/jsx.ts:2668

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.

Inherited from​

AdwDialogProps.presentationMode


receivesDefault?​

optional receivesDefault: boolean

Defined in: packages/react/src/generated/jsx.ts:134

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

Inherited from​

AdwDialogProps.receivesDefault


ref?​

optional ref: Ref<AboutDialog>

Defined in: packages/react/src/generated/jsx.ts:765

Overrides​

AdwDialogProps.ref


releaseNotes?​

optional releaseNotes: string

Defined in: packages/react/src/generated/jsx.ts:697

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.

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


releaseNotesVersion?​

optional releaseNotesVersion: string

Defined in: packages/react/src/generated/jsx.ts:712

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, AdwAboutDialog.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 AdwAboutDialog.release-notes.


sensitive?​

optional sensitive: boolean

Defined in: packages/react/src/generated/jsx.ts:136

Whether the widget responds to input.

Inherited from​

AdwDialogProps.sensitive


supportUrl?​

optional supportUrl: string

Defined in: packages/react/src/generated/jsx.ts:718

The URL of the application's support page.

The support page link is displayed on the main page.


title?​

optional title: string

Defined in: packages/react/src/generated/jsx.ts:2670

The title of the dialog.

Inherited from​

AdwDialogProps.title


tooltipMarkup?​

optional tooltipMarkup: string | null

Defined in: packages/react/src/generated/jsx.ts:152

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

Also see Tooltip.set_markup.

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

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

Inherited from​

AdwDialogProps.tooltipMarkup


tooltipText?​

optional tooltipText: string | null

Defined in: packages/react/src/generated/jsx.ts:167

Sets the text of tooltip to be the given string.

Also see Tooltip.set_text.

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

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

Inherited from​

AdwDialogProps.tooltipText


translatorCredits?​

optional translatorCredits: string

Defined in: packages/react/src/generated/jsx.ts:739

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:

  • AdwAboutDialog.developers
  • AdwAboutDialog.designers
  • AdwAboutDialog.artists
  • AdwAboutDialog.documenters
  • AboutDialogadd_credit_section
  • AboutDialogadd_acknowledgement_section

valign?​

optional valign: Align

Defined in: packages/react/src/generated/jsx.ts:169

How to distribute vertical space if widget gets extra space.

Inherited from​

AdwDialogProps.valign


version?​

optional version: string

Defined in: packages/react/src/generated/jsx.ts:748

The version of the application.

The version is displayed on the main page.

If AdwAboutDialog.release-notes-version is not set, the version will also be displayed above the release notes on the What's New page.


vexpand?​

optional vexpand: boolean

Defined in: packages/react/src/generated/jsx.ts:171

Whether to expand vertically.

Inherited from​

AdwDialogProps.vexpand


vexpandSet?​

optional vexpandSet: boolean

Defined in: packages/react/src/generated/jsx.ts:173

Whether to use the vexpand property.

Inherited from​

AdwDialogProps.vexpandSet


visible?​

optional visible: boolean

Defined in: packages/react/src/generated/jsx.ts:175

Whether the widget is visible.

Inherited from​

AdwDialogProps.visible


website?​

optional website: string

Defined in: packages/react/src/generated/jsx.ts:757

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


widthRequest?​

optional widthRequest: number

Defined in: packages/react/src/generated/jsx.ts:181

Overrides for width request of the widget.

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

Inherited from​

AdwDialogProps.widthRequest