GPaste.Settings¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get_close_on_select` ()
	`get_element_size` ()
	`get_empty_history_confirmation` ()
	`get_extension_enabled` ()
	`get_growing_lines` ()
	`get_history_name` ()
	`get_images_support` ()
	`get_launch_ui` ()
	`get_make_password` ()
	`get_max_displayed_history_size` ()
	`get_max_history_size` ()
	`get_max_memory_usage` ()
	`get_max_text_item_size` ()
	`get_min_text_item_size` ()
	`get_open_centered` ()
	`get_pop` ()
	`get_primary_to_history` ()
	`get_rich_text_support` ()
	`get_save_history` ()
	`get_show_history` ()
	`get_sync_clipboard_to_primary` ()
	`get_sync_primary_to_clipboard` ()
	`get_synchronize_clipboards` ()
	`get_track_changes` ()
	`get_track_extension_state` ()
	`get_trim_items` ()
	`get_upload` ()
	`reset_close_on_select` ()
	`reset_element_size` ()
	`reset_empty_history_confirmation` ()
	`reset_growing_lines` ()
	`reset_history_name` ()
	`reset_images_support` ()
	`reset_launch_ui` ()
	`reset_make_password` ()
	`reset_max_displayed_history_size` ()
	`reset_max_history_size` ()
	`reset_max_memory_usage` ()
	`reset_max_text_item_size` ()
	`reset_min_text_item_size` ()
	`reset_open_centered` ()
	`reset_pop` ()
	`reset_primary_to_history` ()
	`reset_rich_text_support` ()
	`reset_save_history` ()
	`reset_show_history` ()
	`reset_sync_clipboard_to_primary` ()
	`reset_sync_primary_to_clipboard` ()
	`reset_synchronize_clipboards` ()
	`reset_track_changes` ()
	`reset_track_extension_state` ()
	`reset_trim_items` ()
	`reset_upload` ()
	`set_close_on_select` (value)
	`set_element_size` (value)
	`set_empty_history_confirmation` (value)
	`set_extension_enabled` (value)
	`set_growing_lines` (value)
	`set_history_name` (value)
	`set_images_support` (value)
	`set_launch_ui` (value)
	`set_make_password` (value)
	`set_max_displayed_history_size` (value)
	`set_max_history_size` (value)
	`set_max_memory_usage` (value)
	`set_max_text_item_size` (value)
	`set_min_text_item_size` (value)
	`set_open_centered` (value)
	`set_pop` (value)
	`set_primary_to_history` (value)
	`set_rich_text_support` (value)
	`set_save_history` (value)
	`set_show_history` (value)
	`set_sync_clipboard_to_primary` (value)
	`set_sync_primary_to_clipboard` (value)
	`set_synchronize_clipboards` (value)
	`set_track_changes` (value)
	`set_track_extension_state` (value)
	`set_trim_items` (value)
	`set_upload` (value)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`changed`	The “changed” signal is emitted when a key has potentially changed.
`rebind`	The “rebind” signal is emitted when a key has potentially changed.
`track`	The “track” signal is emitted when the daemon starts or stops tracking clipboard changes

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class GPaste.Settings(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: GPaste.SettingsClass

classmethod new()¶

Returns:: a newly allocated GPaste.Settings free it with GObject.Object.unref
Return type:: GPaste.Settings

Create a new instance of GPaste.Settings

get_close_on_select()¶

Returns:: the value of the “close-on-select” setting
Return type:: bool

Get the “close-on-select” setting

get_element_size()¶

Returns:: the value of the “element-size” setting
Return type:: int

Get the “element-size” setting

get_empty_history_confirmation()¶

Returns:: the value of the “empty-history-confirmation” setting
Return type:: bool

Get the “empty-history-confirmation” setting

get_extension_enabled()¶

Returns:: Whether the gnome-shell extension is enabled or not
Return type:: bool

Get the “extension-enabled” special setting

get_growing_lines()¶

Returns:: the value of the “growing-lines” setting
Return type:: bool

Get the “growing-lines” setting

get_history_name()¶

Returns:: the value of the “history-name” setting
Return type:: str

Get the “history-name” setting

get_images_support()¶

Returns:: the value of the “images-support” setting
Return type:: bool

Get the “images-support” setting

get_launch_ui()¶

Returns:: the value of the “launch-ui” setting
Return type:: str

Get the “launch-ui” setting

get_make_password()¶

Returns:: the value of the “make-password” setting
Return type:: str

Get the “make-password” setting

get_max_displayed_history_size()¶

Returns:: the value of the “max-displayed-history-size” setting
Return type:: int

Get the “max-displayed-history-size” setting

get_max_history_size()¶

Returns:: the value of the “max-history-size” setting
Return type:: int

Get the “max-history-size” setting

get_max_memory_usage()¶

Returns:: the value of the “max-memory-usage” setting
Return type:: int

Get the “max-memory-usage” setting

get_max_text_item_size()¶

Returns:: the value of the “max-text-item-size” setting
Return type:: int

Get the “max-text-item-size” setting

get_min_text_item_size()¶

Returns:: the value of the “min-text-item-size” setting
Return type:: int

Get the “min-text-item-size” setting

get_open_centered()¶

Returns:: the value of the “open-centered” setting
Return type:: bool

Get the “open-centered” setting

get_pop()¶

Returns:: the value of the “pop” setting
Return type:: str

Get the “pop” setting

get_primary_to_history()¶

Returns:: the value of the “primary-to-history” setting
Return type:: bool

Get the “primary-to-history” setting

get_rich_text_support()¶

Returns:: the value of the “rich-text-support” setting
Return type:: bool

Get the “rich-text-support” setting

get_save_history()¶

Returns:: the value of the “save-history” setting
Return type:: bool

Get the “save-history” setting

get_show_history()¶

Returns:: the value of the “show-history” setting
Return type:: str

Get the “show-history” setting

get_sync_clipboard_to_primary()¶

Returns:: the value of the “sync-clipboard-to-primary” setting
Return type:: str

Get the “sync-clipboard-to-primary” setting

get_sync_primary_to_clipboard()¶

Returns:: the value of the “sync-primary-to-clipboard” setting
Return type:: str

Get the “sync-primary-to-clipboard” setting

get_synchronize_clipboards()¶

Returns:: the value of the “synchronize-clipboards” setting
Return type:: bool

Get the “synchronize-clipboards” setting

get_track_changes()¶

Returns:: the value of the “track-changes” setting
Return type:: bool

Get the “track-changes” setting

get_track_extension_state()¶

Returns:: the value of the “track-extension-state” setting
Return type:: bool

Get the “track-extension-state” setting

get_trim_items()¶

Returns:: the value of the “trim-items” setting
Return type:: bool

Get the “trim-items” setting

get_upload()¶

Returns:: the value of the “upload” setting
Return type:: str

Get the “upload” setting

reset_close_on_select()¶: Reset the “close-on-select” setting

reset_element_size()¶: Reset the “element-size” setting

reset_empty_history_confirmation()¶: Reset the “empty-history-confirmation” setting

reset_growing_lines()¶: Reset the “growing-lines” setting

reset_history_name()¶: Reset the “history-name” setting

reset_images_support()¶: Reset the “images-support” setting

reset_launch_ui()¶: Reset the “launch-ui” setting

reset_make_password()¶: Reset the “make-password” setting

reset_max_displayed_history_size()¶: Reset the “max-displayed-history-size” setting

reset_max_history_size()¶: Reset the “max-history-size” setting

reset_max_memory_usage()¶: Reset the “max-memory-usage” setting

reset_max_text_item_size()¶: Reset the “max-text-item-size” setting

reset_min_text_item_size()¶: Reset the “min-text-item-size” setting

reset_open_centered()¶: Reset the “open-centered” setting

reset_pop()¶: Reset the “pop” setting

reset_primary_to_history()¶: Reset the “primary-to-history” setting

reset_rich_text_support()¶: Reset the “rich-text-support” setting

reset_save_history()¶: Reset the “save-history” setting

reset_show_history()¶: Reset the “show-history” setting

reset_sync_clipboard_to_primary()¶: Reset the “sync-clipboard-to-primary” setting

reset_sync_primary_to_clipboard()¶: Reset the “sync-primary-to-clipboard” setting

reset_synchronize_clipboards()¶: Reset the “synchronize-clipboards” setting

reset_track_changes()¶: Reset the “track-changes” setting

reset_track_extension_state()¶: Reset the “track-extension-state” setting

reset_trim_items()¶: Reset the “trim-items” setting

reset_upload()¶: Reset the “upload” setting

set_close_on_select(value)¶

Parameters:: value (bool) – the new history name

Change the “close-on-select” setting

set_element_size(value)¶

Parameters:: value (int) – the maximum displayed size of an item

Change the “element-size” setting

set_empty_history_confirmation(value)¶

Parameters:: value (bool) – whether to prompt for confirmation when emptying a history

Change the “empty-history-confirmation” setting

set_extension_enabled(value)¶

Parameters:: value (bool) – whether to enable or not the gnome-shell extension

Change the “extension-enabled” special setting

set_growing_lines(value)¶

Parameters:: value (bool) – whether to detect or not growing lines

Change the “growing-lines” setting

set_history_name(value)¶

Parameters:: value (str) – the new history name

Change the “history-name” setting

set_images_support(value)¶

Parameters:: value (bool) – the new history name

Change the “images-support” setting

set_launch_ui(value)¶

Parameters:: value (str) – the new keyboard shortcut

Change the “launch-ui” setting

set_make_password(value)¶

Parameters:: value (str) – the new keyboard shortcut

Change the “make-password” setting

set_max_displayed_history_size(value)¶

Parameters:: value (int) – the maximum number of items to display

Change the “max-displayed-history-size” setting

set_max_history_size(value)¶

Parameters:: value (int) – the maximum number of items the history can contain

Change the “max-history-size” setting

set_max_memory_usage(value)¶

Parameters:: value (int) – the maximum amount of memory we can use

Change the “max-memory-usage” setting

set_max_text_item_size(value)¶

Parameters:: value (int) – the maximum size for a textual item to be handled

Change the “max-text-item-size” setting

set_min_text_item_size(value)¶

Parameters:: value (int) – the minimum size for a textual item to be handled

Change the “min-text-item-size” setting

set_open_centered(value)¶

Parameters:: value (bool) – the new history name

Change the “open-centered” setting

set_pop(value)¶

Parameters:: value (str) – the new keyboard shortcut

Change the “pop” setting

set_primary_to_history(value)¶

Parameters:: value (bool) – whether to track or not the primary selection changes as clipboard ones

Change the “primary-to-history” setting

set_rich_text_support(value)¶

Parameters:: value (bool) – the new history name

Change the “rich-text-support” setting

set_save_history(value)¶

Parameters:: value (bool) – whether to save or not the history

Change the “save-history” setting

set_show_history(value)¶

Parameters:: value (str) – the new keyboard shortcut

Change the “show-history” setting

set_sync_clipboard_to_primary(value)¶

Parameters:: value (str) – the new keyboard shortcut

Change the “sync-clipboard-to-primary” setting

set_sync_primary_to_clipboard(value)¶

Parameters:: value (str) – the new keyboard shortcut

Change the “sync-primary-to-clipboard” setting

set_synchronize_clipboards(value)¶

Parameters:: value (bool) – whether to synchronize the clipboard and the primary selection or not

Change the “synchronize-clipboards” setting

set_track_changes(value)¶

Parameters:: value (bool) – whether to track or not the clipboard changes

Change the “track-changes” setting

set_track_extension_state(value)¶

Parameters:: value (bool) – whether to stop tracking or not the clipboard changes when an applet exits

Change the “track-extension-state” setting

set_trim_items(value)¶

Parameters:: value (bool) – whether to trim or not textual items

Change the “trim-items” setting

set_upload(value)¶

Parameters:: value (str) – the new keyboard shortcut

Change the “upload” setting

Signal Details¶

GPaste.Settings.signals.changed(settings, key)¶

Signal Name:

changed

Flags:

RUN_LAST, DETAILED

Parameters:

settings (GPaste.Settings) – The object which received the signal
key (str) – the name of the key that changed

The “changed” signal is emitted when a key has potentially changed. You should call one of the g_paste_settings_get() calls to check the new value.

This signal supports detailed connections. You can connect to the detailed signal “changed::x” in order to only receive callbacks when key “x” changes.

GPaste.Settings.signals.rebind(settings, key)¶

Signal Name:

rebind

Flags:

RUN_LAST, DETAILED

Parameters:

settings (GPaste.Settings) – The object which received the signal
key (str) – the name of the key that changed

The “rebind” signal is emitted when a key has potentially changed. You should call one of the g_paste_settings_get() calls to check the new value.

This signal supports detailed connections. You can connect to the detailed signal “rebind::x” in order to only receive callbacks when key “x” changes.

GPaste.Settings.signals.track(settings, tracking_state)¶

Signal Name:

track

Flags:

RUN_LAST

Parameters:

settings (GPaste.Settings) – The object which received the signal
tracking_state (bool) – whether we’re now tracking or not

The “track” signal is emitted when the daemon starts or stops tracking clipboard changes