AgsGui.FileWidget¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Box (14), Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1), Gtk.Orientable (2)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`add_bookmark` (bookmark_location)
	`add_location` (button_action, button_text)
	`create_dir` (dir_path)
	`get_app_generic_path` ()
	`get_app_home_path` ()
	`get_bookmark` ()
	`get_bookmark_filename` ()
	`get_current_path` ()
	`get_default_bundle` ()
	`get_default_path` ()
	`get_file_magic_executable` ()
	`get_filename` ()
	`get_filenames` ()
	`get_home_path` ()
	`get_location` ()
	`get_recently_used` ()
	`get_recently_used_filename` ()
	`read_bookmark` ()
	`read_recently_used` ()
	`refresh` ()
	`remove_bookmark` (bookmark_location)
	`remove_location` (button_action)
	`set_app_generic_path` (app_generic_path)
	`set_app_home_path` (app_home_path)
	`set_bookmark_filename` (bookmark_filename)
	`set_current_path` (current_path)
	`set_default_bundle` (default_bundle)
	`set_default_path` (default_path)
	`set_file_action` (file_action)
	`set_file_filter` (file_filter)
	`set_file_magic_executable` (file_magic_executable)
	`set_flags` (flags)
	`set_home_path` (home_path)
	`set_recently_used_filename` (recently_used_filename)
	`test_file_action` (file_action)
	`test_file_filter` (file_filter)
	`test_flags` (flags)
	`unset_flags` (flags)
	`write_bookmark` ()
	`write_recently_used` ()

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

	`do_create_dir` (dir_path)
	`do_refresh` ()

Properties¶

Inherited:: Gtk.Box (4), Gtk.Widget (34), Gtk.Accessible (1), Gtk.Orientable (1)

Name	Type	Flags	Short Description
`app-generic-path`	`str`	r/w	The app generic path
`app-home-path`	`str`	r/w	The app home path
`bookmark-filename`	`str`	r/w	The bookmark filename
`current-path`	`str`	r/w	The current path
`default-bundle`	`str`	r/w	The default bundle
`default-path`	`str`	r/w	The default path
`file-magic-executable`	`str`	r/w	The file magic executable
`home-path`	`str`	r/w	The home path
`recently-used-filename`	`str`	r/w	The recently used filename

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Name	Short Description
`create-dir`	The `::create-dir` signal notifies about creating directory.
`refresh`	The `::refresh` signal notifies about filesystem change.

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Name	Type	Access
action_group	`Gio.SimpleActionGroup`	r
action_menu_button	`Gtk.MenuButton`	r
action_popover	`Gtk.PopoverMenu`	r
action_popup	`Gio.Menu`	r
app_generic_path	`str`	r
app_home_path	`str`	r
bookmark	{`object`: `object`}	r
bookmark_box	`Gtk.Box`	r
bookmark_filename	`str`	r
box	`Gtk.Box`	r
center_vbox	`Gtk.Box`	r
current_file_filter	`str`	r
current_path	`str`	r
default_bundle	`str`	r
default_path	`str`	r
file_action	`int`	r
file_filter	`int`	r
file_filter_drop_down	`Gtk.DropDown`	r
file_filter_suffix	`str`	r
file_magic_executable	`str`	r
filename_factory	[`Gtk.ListItemFactory`]	r
filename_key_selection	`Gtk.NoSelection`	r
filename_multi_selection	`Gtk.MultiSelection`	r
filename_scrolled_window	`Gtk.ScrolledWindow`	r
filename_single_selection	`Gtk.SingleSelection`	r
filename_view	`Gtk.ColumnView`	r
flags	`int`	r
home_path	`str`	r
left_vbox	`Gtk.Box`	r
location	{`object`: `object`}	r
location_box	`Gtk.Box`	r
location_drop_down	`Gtk.DropDown`	r
location_entry	`Gtk.Entry`	r
location_separator	`Gtk.Separator`	r
preview	`Gtk.Widget`	r
recently_used	`str`	r
recently_used_filename	`str`	r
recently_used_link	`AgsGui.IconLink`	r
right_vbox	`Gtk.Box`	r
sandbox_path	`str`	r
vbox	`Gtk.Box`	r

Class Details¶

class AgsGui.FileWidget(**kwargs)¶

Bases:: Gtk.Box
Abstract:: No
Structure:: AgsGui.FileWidgetClass

classmethod new()¶

Returns:: the new AgsGui.FileWidget
Return type:: AgsGui.FileWidget

Creates a new instance of AgsGui.FileWidget.

New in version 6.6.0.

add_bookmark(bookmark_location)¶

Parameters:: bookmark_location (str) – the bookmark location

Add bookmark_location to bookmark with button_text.

New in version 6.6.0.

add_location(button_action, button_text)¶

Parameters:

button_action (str) – the button action
button_text (str) – the button text

Add button_action to location with button_text.

New in version 6.6.0.

create_dir(dir_path)¶

Parameters:: dir_path (str) – the directory path

Create directory dir_path.

New in version 6.6.0.

get_app_generic_path()¶

Returns:: the app generic path as string
Return type:: str

Get app generic path of self.

New in version 6.6.0.

get_app_home_path()¶

Returns:: the app home path as string
Return type:: str

Get app home path of self.

New in version 6.6.0.

get_bookmark()¶

Returns:: the bookmark GLib.HashTable
Return type:: {object: object}

Get bookmark from self.

New in version 6.6.0.

get_bookmark_filename()¶

Returns:: the bookmark filename as string
Return type:: str

Get bookmark filename of self.

New in version 6.6.0.

get_current_path()¶

Returns:: the current path as string
Return type:: str

Get current path of self.

New in version 6.6.0.

get_default_bundle()¶

Returns:: the default bundle as string
Return type:: str

Get default bundle of self.

New in version 6.6.0.

get_default_path()¶

Returns:: the default path as string
Return type:: str

Get default path of self.

New in version 6.6.0.

get_file_magic_executable()¶

Returns:: the file magic executable as string
Return type:: str

Get file magic executable of self.

New in version 6.6.0.

get_filename()¶

Returns:: the filename as string
Return type:: str

Get filename of self.

New in version 6.6.0.

get_filenames()¶

Returns:: the filename as string
Return type:: [str]

Get filenames of self.

New in version 6.6.0.

get_home_path()¶

Returns:: the home path as string
Return type:: str

Get home path of self.

New in version 6.6.0.

get_location()¶

Returns:: the location GLib.HashTable
Return type:: {object: object}

Get location from self.

New in version 6.6.0.

get_recently_used()¶

Returns:

the recently used string vector

strv_length:: the string vector length

Return type:

([str], strv_length: int)

Get recently used from self.

New in version 6.6.0.

get_recently_used_filename()¶

Returns:: the home path as string
Return type:: str

Get recently used filename of self.

New in version 6.6.0.

read_bookmark()¶: Read bookmarks from bookmark-filename.

New in version 6.6.0.

read_recently_used()¶: Read recently-used from recently-used-filename.

New in version 6.6.0.

refresh()¶: Refresh self due to current path change.

New in version 6.6.0.

remove_bookmark(bookmark_location)¶

Parameters:: bookmark_location (str) – the bookmark location

Remove bookmark_location from bookmark with button_text.

New in version 6.6.0.

remove_location(button_action)¶

Parameters:: button_action (str) – the button action

Remove button_action from location with button_text.

New in version 6.6.0.

set_app_generic_path(app_generic_path)¶

Parameters:: app_generic_path (str) – the app generic path

Set app_generic_path of self.

New in version 6.6.0.

set_app_home_path(app_home_path)¶

Parameters:: app_home_path (str) – the app home path

Set app_home_path of self.

New in version 6.6.0.

set_bookmark_filename(bookmark_filename)¶

Parameters:: bookmark_filename (str) – the bookmark filename

Set bookmark_filename of self.

New in version 6.6.0.

set_current_path(current_path)¶

Parameters:: current_path (str) – the current path

Set current_path of self.

New in version 6.6.0.

set_default_bundle(default_bundle)¶

Parameters:: default_bundle (str) – the default bundle

Set default_bundle of self.

New in version 6.6.0.

set_default_path(default_path)¶

Parameters:: default_path (str) – the default path

Set default_path of self.

New in version 6.6.0.

set_file_action(file_action)¶

Parameters:: file_action (int) – the file action

Set file_action of self.

New in version 6.6.0.

set_file_filter(file_filter)¶

Parameters:: file_filter (int) – the file filter

Set file_filter of self.

New in version 6.6.0.

set_file_magic_executable(file_magic_executable)¶

Parameters:: file_magic_executable (str) – the file magic executable

Set file_magic_executable of self.

New in version 6.6.0.

set_flags(flags)¶

Parameters:: flags (int) – the flags

Set flags of self.

New in version 6.6.0.

set_home_path(home_path)¶

Parameters:: home_path (str) – the home path

Set home_path of self.

New in version 6.6.0.

set_recently_used_filename(recently_used_filename)¶

Parameters:: recently_used_filename (str) – the recently used filename

Set recently_used_filename of self.

New in version 6.6.0.

test_file_action(file_action)¶

Parameters:: file_action (int) – the file action
Returns:: True if file action matches, otherwise False
Return type:: bool

Test file_action of self.

New in version 6.6.0.

test_file_filter(file_filter)¶

Parameters:: file_filter (int) – the file filter
Returns:: True if file filter matches, otherwise False
Return type:: bool

Test file_filter of self.

New in version 6.6.0.

test_flags(flags)¶

Parameters:: flags (int) – the flags
Returns:: True if flags set, otherwise False
Return type:: bool

Test flags of self.

New in version 6.6.0.

unset_flags(flags)¶

Parameters:: flags (int) – the flags

Set flags of self.

New in version 6.6.0.

write_bookmark()¶: Write bookmarks from bookmark-filename.

New in version 6.6.0.

write_recently_used()¶: Write recently_useds from recently_used-filename.

New in version 6.6.0.

do_create_dir(dir_path) virtual¶

Parameters:: dir_path (str) – the directory path

Create directory dir_path.

New in version 6.6.0.

do_refresh() virtual¶: Refresh file_widget due to current path change.

New in version 6.6.0.

Signal Details¶

AgsGui.FileWidget.signals.create_dir(file_widget, dir_path)¶

Signal Name:

create-dir

Flags:

RUN_LAST

Parameters:

file_widget (AgsGui.FileWidget) – The object which received the signal
dir_path (str) – the directory path

The ::create-dir signal notifies about creating directory.

New in version 6.6.0.

AgsGui.FileWidget.signals.refresh(file_widget)¶

Signal Name:: refresh
Flags:: RUN_LAST
Parameters:: file_widget (AgsGui.FileWidget) – The object which received the signal

The ::refresh signal notifies about filesystem change.

New in version 6.6.0.

Property Details¶

AgsGui.FileWidget.props.app_generic_path¶

Name:: app-generic-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The app generic path.

New in version 6.6.0.

AgsGui.FileWidget.props.app_home_path¶

Name:: app-home-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The app home path.

New in version 6.6.0.

AgsGui.FileWidget.props.bookmark_filename¶

Name:: bookmark-filename
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The recently used filename.

New in version 6.6.0.

AgsGui.FileWidget.props.current_path¶

Name:: current-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The current path.

New in version 6.6.0.

AgsGui.FileWidget.props.default_bundle¶

Name:: default-bundle
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The default bundle.

New in version 6.6.0.

AgsGui.FileWidget.props.default_path¶

Name:: default-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The default path.

New in version 6.6.0.

AgsGui.FileWidget.props.file_magic_executable¶

Name:: file-magic-executable
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The file magic executable.

New in version 6.6.0.

AgsGui.FileWidget.props.home_path¶

Name:: home-path
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The home path.

New in version 6.6.0.

AgsGui.FileWidget.props.recently_used_filename¶

Name:: recently-used-filename
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

The recently used filename.

New in version 6.6.0.