Gnome::Gtk4::ListView
use v6.d;
#------------------------------------------------------------------------------- #--[Class Description]---------------------------------------------------------- #-------------------------------------------------------------------------------
=begin rakudoc
Description
Gnome::Gtk4::ListView presents a large dynamic list of items.
Gnome::Gtk4::ListView uses its factory to generate one row widget for each visible item and shows them in a linear display, either vertically or horizontally.
The .set-show-separators() method offers a simple way to
set separators between the rows.
Gnome::Gtk4::ListView allows the user to select items according to the selection
characteristics of the model. For models that allow multiple selected items,
it is possible to turn on rubberband selection, using
.set-enable-rubberband().
If you need multiple columns with headers, see Gnome::Gtk4::ColumnView.
To learn more about the list widget framework, see the overview.
CSS nodes
listview[.separators][.rich-list][.navigation-sidebar][.data-table]
├── row[.activatable]
│
├── row[.activatable]
│
┊
╰── [rubberband]
Gnome::Gtk4::ListView uses a single CSS node named listview. It may carry the .separators style class, when show-separators property is set. Each child widget uses a single CSS node named row. If the activatable defined in Gnome::Gtk4::ListItem property is set, the corresponding row will have the .activatable style class. For rubberband selection, a node with name rubberband is used.
The main listview node may also carry style classes to select the style of list presentation: .rich-list, .navigation-sidebar or .data-table.
Accessibility
Gnome::Gtk4::ListView uses the GTK_ACCESSIBLE_ROLE_LIST role, and the list
items use the GTK_ACCESSIBLE_ROLE_LIST_ITEM role.
Uml Diagram
=end rakudoc
#------------------------------------------------------------------------------- #--[Class Initialization]------------------------------------------------------- #-------------------------------------------------------------------------------
=begin rakudoc
Class initialization
new
:native-object
Create an object using a native object from an object of the same type found elsewhere. See also Gnome::N::TopLevelSupportClass.
method new ( N-Object() :$native-object! )
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
new-listview
Creates a new Gnome::Gtk4::ListView that uses the given $factory for
mapping items to widgets.
The function takes ownership of the arguments, so you can write code like
method new-listview ( N-Object() $model, N-Object() $factory --> Gnome::Gtk4::ListView )
$model; (transfer ownership: full) the model to use.
$factory; (transfer ownership: full) The factory to populate items with.
=end rakudoc
#------------------------------------------------------------------------------- #--[Methods]-------------------------------------------------------------------- #-------------------------------------------------------------------------------
=begin rakudoc
Methods
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
get-enable-rubberband
Returns whether rows can be selected by dragging with the mouse.
method get-enable-rubberband (--> Bool )
Return value; True if rubberband selection is enabled.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
get-factory
Gets the factory that's currently used to populate list items.
method get-factory (--> N-Object )
Return value; The factory in use.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
get-header-factory
Gets the factory that's currently used to populate section headers.
method get-header-factory (--> N-Object )
Return value; The factory in use.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
get-model
Gets the model that's currently used to read the items displayed.
method get-model (--> N-Object )
Return value; The model in use.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
get-show-separators
Returns whether the list box should show separators between rows.
method get-show-separators (--> Bool )
Return value; True if the list box shows separators.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
get-single-click-activate
Returns whether rows will be activated on single click and selected on hover.
method get-single-click-activate (--> Bool )
Return value; True if rows are activated on single click.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
get-tab-behavior
Gets the behavior set for the <kbd>Tab</kbd> key.
method get-tab-behavior (--> GtkListTabBehavior )
Return value; The behavior of the <kbd>Tab</kbd> key.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
scroll-to
Scrolls to the item at the given position and performs the actions
specified in $flags.
This function works no matter if the listview is shown or focused. If it isn't, then the changes will take effect once that happens.
method scroll-to ( UInt() $pos, UInt $flags, N-Object $scroll )
$pos; position of the item. Must be less than the number of items in the view..
$flags; actions to perform.
$scroll; (transfer ownership: full) details of how to perform the scroll operation or undefined to scroll into view
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
set-enable-rubberband
Sets whether selections can be changed by dragging with the mouse.
method set-enable-rubberband ( Bool() $enable-rubberband )
$enable-rubberband;
Trueto enable rubberband selection.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
set-factory
Sets the Gnome::Gtk4::ListItemFactory to use for populating list items.
method set-factory ( N-Object() $factory )
$factory; the factory to use.
Example using set-factory
my Gnome::Gtk4::ListView $list-view;
with $list-view .= new-listview( N-Object, N-Object) {
my $signal-factory .= new-signallistitemfactory;
.set-factory($!signal-factory);
…
}
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
set-header-factory
Sets the Gnome::Gtk4::ListItemFactory to use for populating the Gnome::Gtk4::ListHeader objects used in section headers.
If this factory is set to undefined, the list will not show section headers.
method set-header-factory ( N-Object() $factory )
$factory; the factory to use.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
set-model
Sets the model to use.
This must be a Gnome::Gtk4::ListHeader to use.
method set-model ( N-Object() $model )
$model; the model to use.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
set-show-separators
Sets whether the list box should show separators between rows.
method set-show-separators ( Bool() $show-separators )
$show-separators;
Trueto show separators.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
set-single-click-activate
Sets whether rows should be activated on single click and selected on hover.
method set-single-click-activate ( Bool() $single-click-activate )
$single-click-activate;
Trueto activate items on single click.
=end rakudoc
#------------------------------------------------------------------------------- =begin rakudoc
set-tab-behavior
Sets the behavior of the <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> keys.
method set-tab-behavior ( GtkListTabBehavior $tab-behavior )
$tab-behavior; The desired tab behavior.
=end rakudoc
#------------------------------------------------------------------------------- #--[Signal Documentation]------------------------------------------------------- #-------------------------------------------------------------------------------
=begin rakudoc
Signals
activate
Emitted when a row has been activated by the user, usually via activating the GtkListView|list.activate-item action.
This allows for a convenient way to handle activation in a listview. See .set-activatable() in class ListItem for details on how to use this signal.
method handler (
guint $position,
Int :$_handle_id,
N-GObject :$_native-object,
*%user-options
)
$position; position of item to activate.
$_handle_id; The registered event handler id.
$_native-object; The native object provided by the Raku object which registered this event. This is a native Gnome::Gtk4::ListView object.
%user-options; A list of named arguments provided by .register-signal() in class Object.
=end rakudoc