Dazzle.ShortcutTooltip

g Dazzle.ShortcutTooltip Dazzle.ShortcutTooltip GObject.Object GObject.Object GObject.Object->Dazzle.ShortcutTooltip

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

get_accel ()

get_command_id ()

get_title ()

get_widget ()

set_accel (accel)

set_command_id (command_id)

set_title (title)

set_widget (widget)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

accel

str

r/w/en

The accel for the label, if overriding the discovered accel

command-id

str

r/w/en

The shortcut command-id to track for shortcut changes

title

str

r/w/en

Title for the tooltip

widget

Gtk.Widget

r/w/en

The widget to monitor for query-tooltip

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Dazzle.ShortcutTooltip(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Dazzle.ShortcutTooltipClass

classmethod new()
Returns:

a newly created Dazzle.ShortcutTooltip

Return type:

Dazzle.ShortcutTooltip

Create a new Dazzle.ShortcutTooltip.

New in version 3.32.

get_accel()
Returns:

an override accel, or None

Return type:

str or None

Gets the Dazzle.ShortcutTooltip :accel property, which can be used to override the commands accel.

New in version 3.32.

get_command_id()
Returns:

a string containing the command id

Return type:

str or None

Gets the Dazzle.ShortcutTooltip :command-id property.

New in version 3.32.

get_title()
Returns:

a string containing the title, or None

Return type:

str or None

Gets the Dazzle.ShortcutTooltip :title property, if set.

New in version 3.32.

get_widget()
Returns:

a Gtk.Widget or None if unset

Return type:

Gtk.Widget or None

Gets the Gtk.Widget that the shortcut-tooltip is wrapping.

New in version 3.32.

set_accel(accel)
Parameters:

accel (str or None) – Sets the accelerator to use, or None to unset and use the default

Allows overriding the accel that is used.

New in version 3.32.

set_command_id(command_id)
Parameters:

command_id (str) – the command-id of the shortcut registered

This sets the Dazzle.ShortcutTooltip :command-id property which denotes which shortcut registered with libdazzle to display when a tooltip request is received.

New in version 3.32.

set_title(title)
Parameters:

title (str or None) – a title for the tooltip, or None

Sets the Dazzle.ShortcutTooltip :title property, which can be used to override the default title for the tooltip as discovered from the shortcut manager.

New in version 3.32.

set_widget(widget)
Parameters:

widget (Gtk.Widget or None) – a Gtk.Widget or None

Sets the widget to connect to the Gtk.Widget ::query-tooltip signal.

If configured, the widget will be displayed with an appropriate tooltip message matching the shortcut from Dazzle.ShortcutTooltip :command-id.

New in version 3.32.

Property Details

Dazzle.ShortcutTooltip.props.accel
Name:

accel

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The accel for the label, if overriding the discovered accel

Dazzle.ShortcutTooltip.props.command_id
Name:

command-id

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The shortcut command-id to track for shortcut changes

Dazzle.ShortcutTooltip.props.title
Name:

title

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The “title” property contains an alternate title for the tooltip instead of discovering the title from the shortcut manager.

New in version 3.32.

Dazzle.ShortcutTooltip.props.widget
Name:

widget

Type:

Gtk.Widget

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The widget to monitor for query-tooltip