Class

AgsGuiFileWidget

since: 6.0

Description

class AgsGui.FileWidget : Gtk.Box
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
  flags: guint,
  file_action: guint,
  file_filter: guint,
  default_bundle: gchar*,
  home_path: gchar*,
  sandbox_path: gchar*,
  app_home_path: gchar*,
  app_generic_path: gchar*,
  default_path: gchar*,
  current_path: gchar*,
  action_group: GSimpleActionGroup*,
  vbox: GtkBox*,
  location_entry: GtkEntry*,
  action_menu_button: GtkMenuButton*,
  action_popover: GtkPopoverMenu*,
  action_popup: GMenu*,
  location_drop_down: GtkDropDown*,
  left_vbox: GtkBox*,
  location_box: GtkBox*,
  location: GHashTable*,
  recently_used_filename: gchar*,
  recently_used: gchar**,
  recently_used_link: AgsIconLink*,
  location_separator: GtkSeparator*,
  bookmark_filename: gchar*,
  bookmark: GHashTable*,
  bookmark_box: GtkBox*,
  center_vbox: GtkBox*,
  file_filter_suffix: gchar**,
  current_file_filter: gchar*,
  filename_key_selection: GtkNoSelection*,
  filename_factory: None,
  filename_single_selection: GtkSingleSelection*,
  filename_multi_selection: GtkMultiSelection*,
  filename_scrolled_window: GtkScrolledWindow*,
  filename_view: GtkColumnView*,
  right_vbox: GtkBox*,
  file_magic_executable: gchar*,
  preview: GtkWidget*,
  file_filter_drop_down: GtkDropDown*
}
No description available.

Available since: 6.0

Constructors

ags_file_widget_new

Creates a new instance of AgsFileWidget.

since: 6.6.0

Instance methods

ags_file_widget_add_bookmark

Add bookmark_location to bookmark with button_text.

since: 6.6.0

ags_file_widget_add_location

Add button_action to location with button_text.

since: 6.6.0

ags_file_widget_create_dir

Create directory dir_path.

since: 6.6.0

ags_file_widget_get_app_generic_path

Get app generic path of file_widget.

since: 6.6.0

ags_file_widget_get_app_home_path

Get app home path of file_widget.

since: 6.6.0

ags_file_widget_get_bookmark

Get bookmark from file_widget.

since: 6.6.0

ags_file_widget_get_bookmark_filename

Get bookmark filename of file_widget.

since: 6.6.0

ags_file_widget_get_current_path

Get current path of file_widget.

since: 6.6.0

ags_file_widget_get_default_bundle

Get default bundle of file_widget.

since: 6.6.0

ags_file_widget_get_default_path

Get default path of file_widget.

since: 6.6.0

ags_file_widget_get_file_filter_suffix
No description available.

since: 6.0

ags_file_widget_get_file_magic_executable

Get file magic executable of file_widget.

since: 6.6.0

ags_file_widget_get_filename

Get filename of file_widget.

since: 6.6.0

ags_file_widget_get_filenames

Get filenames of file_widget.

since: 6.6.0

ags_file_widget_get_home_path

Get home path of file_widget.

since: 6.6.0

ags_file_widget_get_location

Get location from file_widget.

since: 6.6.0

ags_file_widget_get_recently_used

Get recently used from file_widget.

since: 6.6.0

ags_file_widget_get_recently_used_filename

Get recently used filename of file_widget.

since: 6.6.0

ags_file_widget_read_bookmark

Read bookmarks from bookmark-filename.

since: 6.6.0

ags_file_widget_read_recently_used

Read recently-used from recently-used-filename.

since: 6.6.0

ags_file_widget_refresh

Refresh file_widget due to current path change.

since: 6.6.0

ags_file_widget_remove_bookmark

Remove bookmark_location from bookmark with button_text.

since: 6.6.0

ags_file_widget_remove_location

Remove button_action from location with button_text.

since: 6.6.0

ags_file_widget_set_app_generic_path

Set app_generic_path of file_widget.

since: 6.6.0

ags_file_widget_set_app_home_path

Set app_home_path of file_widget.

since: 6.6.0

ags_file_widget_set_bookmark_filename

Set bookmark_filename of file_widget.

since: 6.6.0

ags_file_widget_set_current_path

Set current_path of file_widget.

since: 6.6.0

ags_file_widget_set_default_bundle

Set default_bundle of file_widget.

since: 6.6.0

ags_file_widget_set_default_path

Set default_path of file_widget.

since: 6.6.0

ags_file_widget_set_file_action

Set file_action of file_widget.

since: 6.6.0

ags_file_widget_set_file_filter

Set file_filter of file_widget.

since: 6.6.0

ags_file_widget_set_file_magic_executable

Set file_magic_executable of file_widget.

since: 6.6.0

ags_file_widget_set_flags

Set flags of file_widget.

since: 6.6.0

ags_file_widget_set_home_path

Set home_path of file_widget.

since: 6.6.0

ags_file_widget_set_recently_used_filename

Set recently_used_filename of file_widget.

since: 6.6.0

ags_file_widget_test_file_action

Test file_action of file_widget.

since: 6.6.0

ags_file_widget_test_file_filter

Test file_filter of file_widget.

since: 6.6.0

ags_file_widget_test_flags

Test flags of file_widget.

since: 6.6.0

ags_file_widget_unset_flags

Set flags of file_widget.

since: 6.6.0

ags_file_widget_write_bookmark

Write bookmarks from bookmark-filename.

since: 6.6.0

ags_file_widget_write_recently_used

Write recently_useds from recently_used-filename.

since: 6.6.0

Methods inherited from GtkBox (13)
gtk_box_append

Adds child as the last child to box.

since: 4.0

gtk_box_get_baseline_child

Gets the value set by gtk_box_set_baseline_child().

since: 4.12

gtk_box_get_baseline_position

Gets the value set by gtk_box_set_baseline_position().

since: 4.0

gtk_box_get_homogeneous

Returns whether the box is homogeneous (all children are the same size).

since: 4.0

gtk_box_get_spacing

Gets the value set by gtk_box_set_spacing().

since: 4.0

gtk_box_insert_child_after

Inserts child in the position after sibling in the list of box children.

since: 4.0

gtk_box_prepend

Adds child as the first child to box.

since: 4.0

gtk_box_remove

Removes a child widget from box.

since: 4.0

gtk_box_reorder_child_after

Moves child to the position after sibling in the list of box children.

since: 4.0

gtk_box_set_baseline_child

Sets the baseline child of a box.

since: 4.12

gtk_box_set_baseline_position

Sets the baseline position of a box.

since: 4.0

gtk_box_set_homogeneous

Sets whether or not all children of box are given equal space in the box.

since: 4.0

gtk_box_set_spacing

Sets the number of pixels to place between children of box.

since: 4.0

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (18)
gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

since: 4.0

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

since: 4.0

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

since: 4.0

gtk_accessible_reset_state

Resets the accessible state to its default value.

since: 4.0

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

since: 4.0

gtk_accessible_update_property_value

Updates an array of accessible properties.

since: 4.0

gtk_accessible_update_relation

Updates a list of accessible relations.

since: 4.0

gtk_accessible_update_relation_value

Updates an array of accessible relations.

since: 4.0

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

since: 4.0

gtk_accessible_update_state_value

Updates an array of accessible states.

since: 4.0

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

since: 4.0

Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation

Retrieves the orientation of the orientable.

since: 4.0

gtk_orientable_set_orientation

Sets the orientation of the orientable.

since: 4.0

Properties

AgsGui.FileWidget:app-generic-path

The app generic path.

since: 6.6.0

AgsGui.FileWidget:app-home-path

The app home path.

since: 6.6.0

AgsGui.FileWidget:bookmark-filename

The recently used filename.

since: 6.6.0

AgsGui.FileWidget:current-path

The current path.

since: 6.6.0

AgsGui.FileWidget:default-bundle

The default bundle.

since: 6.6.0

AgsGui.FileWidget:default-path

The default path.

since: 6.6.0

AgsGui.FileWidget:file-magic-executable

The file magic executable.

since: 6.6.0

AgsGui.FileWidget:home-path

The home path.

since: 6.6.0

AgsGui.FileWidget:recently-used-filename

The recently used filename.

since: 6.6.0

Properties inherited from GtkBox (4)
Gtk.Box:baseline-child

The child that determines the baseline, in vertical orientation.

since: 4.12

Gtk.Box:baseline-position

The position of the baseline aligned widgets if extra space is available.

since: 4.0

Gtk.Box:homogeneous

Whether the children should all be the same size.

since: 4.0

Gtk.Box:spacing

The amount of space between children.

since: 4.0

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

since: 4.0

Gtk.Widget:can-target

Whether the widget can receive pointer events.

since: 4.0

Gtk.Widget:css-classes

A list of css classes applied to this widget.

since: 4.0

Gtk.Widget:css-name

The name of this widget in the CSS tree.

since: 4.0

Gtk.Widget:cursor

The cursor used by widget.

since: 4.0

Gtk.Widget:focus-on-click

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

since: 4.0

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

since: 4.0

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

since: 4.0

Gtk.Widget:has-default

Whether the widget is the default widget.

since: 4.0

Gtk.Widget:has-focus

Whether the widget has the input focus.

since: 4.0

Gtk.Widget:has-tooltip

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

since: 4.0

Gtk.Widget:height-request

Override for height request of the widget.

since: 4.0

Gtk.Widget:hexpand

Whether to expand horizontally.

since: 4.0

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

since: 4.0

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

since: 4.0

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

since: 4.0

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

since: 4.0

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

since: 4.0

Gtk.Widget:margin-top

Margin on top side of widget.

since: 4.0

Gtk.Widget:name

The name of the widget.

since: 4.0

Gtk.Widget:opacity

The requested opacity of the widget.

since: 4.0

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

since: 4.0

Gtk.Widget:parent

The parent widget of this widget.

since: 4.0

Gtk.Widget:receives-default

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

since: 4.0

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

since: 4.0

Gtk.Widget:scale-factor

The scale factor of the widget.

since: 4.0

Gtk.Widget:sensitive

Whether the widget responds to input.

since: 4.0

Gtk.Widget:tooltip-markup

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

since: 4.0

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

since: 4.0

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

since: 4.0

Gtk.Widget:vexpand

Whether to expand vertically.

since: 4.0

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

since: 4.0

Gtk.Widget:visible

Whether the widget is visible.

since: 4.0

Gtk.Widget:width-request

Override for width request of the widget.

since: 4.0

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

since: 4.0

Properties inherited from GtkOrientable (1)
Gtk.Orientable:orientation

The orientation of the orientable.

since: 4.0

Signals

AgsGui.FileWidget::create-dir

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

since: 6.6.0

AgsGui.FileWidget::refresh

The ::refresh signal notifies about filesystem change.

since: 6.6.0

Signals inherited from GtkWidget (13)
GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

since: 4.0

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

since: 4.0

GtkWidget::hide

Emitted when widget is hidden.

since: 4.0

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

since: 4.0

GtkWidget::map

Emitted when widget is going to be mapped.

since: 4.0

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

since: 4.0

GtkWidget::move-focus

Emitted when the focus is moved.

since: 4.0

GtkWidget::query-tooltip

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

since: 4.0

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

since: 4.0

GtkWidget::show

Emitted when widget is shown.

since: 4.0

GtkWidget::state-flags-changed

Emitted when the widget state changes.

since: 4.0

GtkWidget::unmap

Emitted when widget is going to be unmapped.

since: 4.0

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

since: 4.0

Signals inherited from GObject (1)
GObject::notify

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.

since: 2.0

Class structure

struct AgsGuiFileWidgetClass {
  GtkBoxClass box;
  void (* refresh) (
    AgsFileWidget* file_widget
  );
  void (* create_dir) (
    AgsFileWidget* file_widget,
    gchar* dir_path
  );
  
}
No description available.
Class members
box: GtkBoxClass
No description available.
refresh: void (* refresh) ( AgsFileWidget* file_widget )
No description available.
create_dir: void (* create_dir) ( AgsFileWidget* file_widget, gchar* dir_path )
No description available.

Virtual methods

AgsGui.FileWidgetClass.create_dir

Create directory dir_path.

since: 6.6.0

AgsGui.FileWidgetClass.refresh

Refresh file_widget due to current path change.

since: 6.6.0