Files
clapper/doc/clapper-gtk/class.QueueSelection.html
2024-01-21 20:51:05 +01:00

737 lines
24 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>ClapperGtk.QueueSelection</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta charset="utf-8" />
<meta property="og:type" content="website"/>
<meta property="og:image:width" content="256"/>
<meta property="og:image:height" content="256"/>
<meta property="og:image:secure_url" content="clapper-logo.svg"/>
<meta property="og:image:alt" content="ClapperGtk-0.0"/>
<meta property="og:title" content="ClapperGtk.QueueSelection"/>
<meta property="og:description" content="Reference for ClapperGtk.QueueSelection"/>
<meta name="twitter:title" content="ClapperGtk.QueueSelection"/>
<meta name="twitter:description" content="Reference for ClapperGtk.QueueSelection"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="ClapperGtk" href="opensearch.xml">
<link rel="stylesheet" href="style.css" type="text/css" />
<script src="urlmap.js"></script>
<script src="fzy.js"></script>
<script src="search.js"></script>
<script src="main.js"></script>
</head>
<body>
<div id="body-wrapper" tabindex="-1">
<nav class="sidebar devhelp-hidden">
<div class="section">
<img src="clapper-logo.svg" class="logo"/>
</div>
<div class="search section">
<form id="search-form" autocomplete="off">
<input id="search-input" type="text" name="do-not-autocomplete" placeholder="Click, or press 's' to search" autocomplete="off"/>
</form>
</div>
<div class="section namespace">
<h3><a href="index.html">ClapperGtk</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.5.2</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a class="current" href="class.QueueSelection.html#description">QueueSelection</a>
</div>
</div>
<div class="section">
<h5>Constructors</h5>
<div class="links">
<a class="ctor" href="ctor.QueueSelection.new.html">new</a>
</div>
</div>
<div class="section">
<h5>Instance methods</h5>
<div class="links">
<a class="method" href="method.QueueSelection.get_queue.html">get_queue</a>
<a class="method" href="method.QueueSelection.set_queue.html">set_queue</a>
</div>
</div>
<div class="section">
<h5>Properties</h5>
<div class="links">
<a class="property" href="property.QueueSelection.queue.html">queue</a>
</div>
</div>
<div class="section">
<h5>Signals</h5>
<div class="links">
<a class="signal" href="signal.QueueSelection.item-query.html">item-query</a>
<a class="signal" href="signal.QueueSelection.item-selected.html">item-selected</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2023.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Class</h3>
<h1 aria-label="Name"><a href="index.html">ClapperGtk</a><span class="sep" role="presentation"></span>QueueSelection</h1>
</header>
<section>
<summary>
<div class="docblock">
<p></p>
</div>
<div class="toggle-wrapper">
<h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/lib/clapper-gtk/clapper-gtk-queue-selection.c#L20">[src]</a>
</h4>
<pre><code>final class ClapperGtk.QueueSelection : GObject.Object
implements Gio.ListModel, Gtk.SelectionModel {
/* No available fields */
}</pre></code>
<div class="docblock">
<p>A <code>GtkSelectionModel</code> that considers current item of <code>ClapperQueue</code> as selected&nbsp;one.</p>
</div>
<div class="docblock">
</div>
</div>
</summary>
<div class="toggle-wrapper hierarchy">
<h4 id="hierarchy">
Hierarchy
<a href="#hierarchy" class="anchor"></a>
</h4>
<div class="docblock" alt="Hierarchy for ClapperGtk.QueueSelection">
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 7.1.0 (0)
-->
<!-- Title: hierarchy Pages: 1 -->
<svg width="260pt" height="188pt"
viewBox="0.00 0.00 260.00 188.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 184)">
<title>hierarchy</title>
<!-- this -->
<g id="node1" class="node">
<title>this</title>
<g id="a_node1"><a xlink:title="ClapperGtkQueueSelection">
<path fill="none" stroke="black" d="M184,-108C184,-108 42,-108 42,-108 36,-108 30,-102 30,-96 30,-96 30,-84 30,-84 30,-78 36,-72 42,-72 42,-72 184,-72 184,-72 190,-72 196,-78 196,-84 196,-84 196,-96 196,-96 196,-102 190,-108 184,-108"/>
<text text-anchor="middle" x="113" y="-86.3" font-family="Times,serif" font-size="14.00">ClapperGtkQueueSelection</text>
</a>
</g>
</g>
<!-- implements_0 -->
<g id="node3" class="node">
<title>implements_0</title>
<g id="a_node3"><a xlink:title="Gio.ListModel">
<polygon fill="none" stroke="black" points="92,-36 0,-36 0,0 92,0 92,-36"/>
<text text-anchor="middle" x="46" y="-14.3" font-family="sans-serif" font-size="14.00">GListModel</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_0 -->
<g id="edge2" class="edge">
<title>this&#45;&#45;implements_0</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M96.44,-71.7C86.05,-60.85 72.72,-46.92 62.37,-36.1"/>
</g>
<!-- implements_1 -->
<g id="node4" class="node">
<title>implements_1</title>
<g id="a_node4"><a xlink:title="Gtk.SelectionModel">
<polygon fill="none" stroke="black" points="252,-36 110,-36 110,0 252,0 252,-36"/>
<text text-anchor="middle" x="181" y="-14.3" font-family="sans-serif" font-size="14.00">GtkSelectionModel</text>
</a>
</g>
</g>
<!-- this&#45;&#45;implements_1 -->
<g id="edge3" class="edge">
<title>this&#45;&#45;implements_1</title>
<path fill="none" stroke="black" stroke-dasharray="1,5" d="M129.81,-71.7C140.35,-60.85 153.88,-46.92 164.38,-36.1"/>
</g>
<!-- ancestor_0 -->
<g id="node2" class="node">
<title>ancestor_0</title>
<g id="a_node2"><a xlink:title="GObject.Object">
<path fill="none" stroke="black" d="M132,-180C132,-180 94,-180 94,-180 88,-180 82,-174 82,-168 82,-168 82,-156 82,-156 82,-150 88,-144 94,-144 94,-144 132,-144 132,-144 138,-144 144,-150 144,-156 144,-156 144,-168 144,-168 144,-174 138,-180 132,-180"/>
<text text-anchor="middle" x="113" y="-158.3" font-family="Times,serif" font-size="14.00">GObject</text>
</a>
</g>
</g>
<!-- ancestor_0&#45;&#45;this -->
<g id="edge1" class="edge">
<title>ancestor_0&#45;&#45;this</title>
<path fill="none" stroke="black" d="M113,-143.7C113,-132.85 113,-118.92 113,-108.1"/>
</g>
</g>
</svg>
</div>
</div>
<div class="toggle-wrapper ancestors">
<h4 id="ancestors">
Ancestors
<a href="#ancestors" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="class"><a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper implements">
<h4 id="implements">
Implements
<a href="#implements" class="anchor"></a>
</h4>
<div class="docblock">
<ul>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.ListModel.html" data-namespace="Gio">GListModel</a></li>
<li class="interface"><a class="external" href="javascript:void(0)" data-link="iface.SelectionModel.html" data-namespace="Gtk">GtkSelectionModel</a></li>
</ul>
</div>
</div>
<div class="toggle-wrapper constructors">
<h4 id="constructors">
Constructors
<a href="#constructors" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="ctor.QueueSelection.new.html">clapper_gtk_queue_selection_new</a></h6>
<div class="docblock">
<p>Creates a new <code>ClapperGtkQueueSelection</code> instance.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper methods">
<h4 id="methods">
Instance methods
<a href="#methods" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="method.QueueSelection.get_queue.html">clapper_gtk_queue_selection_get_queue</a></h6>
<div class="docblock">
<p>Get <code>ClapperQueue</code> managed by this selection&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="method.QueueSelection.set_queue.html">clapper_gtk_queue_selection_set_queue</a></h6>
<div class="docblock">
<p>Set <code>ClapperQueue</code> to be managed by this selection&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (43)</h5>
<div class="docblock">
<div class="docblock">
<p>Please see&nbsp;<a class="external" href="javascript:void(0)" data-link="class.Object.html#methods" data-namespace="GObject">GObject</a>&nbsp;for a full list of methods.</em></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="iface.ListModel.html" data-namespace="Gio">GListModel</a> (5)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_item.html">g_list_model_get_item</a></h6>
<div class="docblock">
<p>Get the item at <code>position</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_item_type.html">g_list_model_get_item_type</a></h6>
<div class="docblock">
<p>Gets the type of the items in <code>list</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_n_items.html">g_list_model_get_n_items</a></h6>
<div class="docblock">
<p>Gets the number of items in <code>list</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.get_object.html">g_list_model_get_object</a></h6>
<div class="docblock">
<p>Get the item at <code>position</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="method.ListModel.items_changed.html">g_list_model_items_changed</a></h6>
<div class="docblock">
<p>Emits the <code>GListModel::items-changed</code> signal on <code>list</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This method will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-methods"><h5 style="display:block;">Methods inherited from <a class="external" href="javascript:void(0)" data-link="iface.SelectionModel.html" data-namespace="Gtk">GtkSelectionModel</a> (11)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.get_selection.html">gtk_selection_model_get_selection</a></h6>
<div class="docblock">
<p>Gets the set containing all currently selected items in the&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.get_selection_in_range.html">gtk_selection_model_get_selection_in_range</a></h6>
<div class="docblock">
<p>Gets the set of selected items in a&nbsp;range.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.is_selected.html">gtk_selection_model_is_selected</a></h6>
<div class="docblock">
<p>Checks if the given item is&nbsp;selected.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.select_all.html">gtk_selection_model_select_all</a></h6>
<div class="docblock">
<p>Requests to select all items in the&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.select_item.html">gtk_selection_model_select_item</a></h6>
<div class="docblock">
<p>Requests to select an item in the&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.select_range.html">gtk_selection_model_select_range</a></h6>
<div class="docblock">
<p>Requests to select a range of items in the&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.selection_changed.html">gtk_selection_model_selection_changed</a></h6>
<div class="docblock">
<p>Helper function for implementations of <code>GtkSelectionModel</code>.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.set_selection.html">gtk_selection_model_set_selection</a></h6>
<div class="docblock">
<p>Make selection&nbsp;changes.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.unselect_all.html">gtk_selection_model_unselect_all</a></h6>
<div class="docblock">
<p>Requests to unselect all items in the&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.unselect_item.html">gtk_selection_model_unselect_item</a></h6>
<div class="docblock">
<p>Requests to unselect an item in the&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="method.SelectionModel.unselect_range.html">gtk_selection_model_unselect_range</a></h6>
<div class="docblock">
<p>Requests to unselect a range of items in the&nbsp;model.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="toggle-wrapper properties">
<h4 id="properties">
Properties
<a href="#properties" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="property.QueueSelection.queue.html">ClapperGtk.QueueSelection:queue</a></h6>
<div class="docblock">
<p>The queue being&nbsp;managed.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="signals toggle-wrapper">
<h4 id="signals">
Signals
<a href="#signals" class="anchor"></a>
</h4>
<div class="docblock">
<div class="">
<h6><a href="signal.QueueSelection.item-query.html">ClapperGtk.QueueSelection::item-query</a></h6>
<div class="docblock">
<p>Signals when the <code>GtkSelectionModel</code> is doing item&nbsp;query.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
<div class="">
<h6><a href="signal.QueueSelection.item-selected.html">ClapperGtk.QueueSelection::item-selected</a></h6>
<div class="docblock">
<p>Signals when user selected item within the <code>GtkSelectionModel</code>.
Note that this signal is emitted only when item gets selected from
the <span class="caps">GTK</span> side. If item was changed internally by e.g. <code>ClapperQueue</code>
progression, this signal will not be&nbsp;emitted.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="class.Object.html" data-namespace="GObject">GObject</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="GObject" data-link="signal.Object.notify.html">GObject::notify</a></h6>
<div class="docblock">
<p>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&nbsp;al.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="iface.ListModel.html" data-namespace="Gio">GListModel</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gio" data-link="signal.ListModel.items-changed.html">GListModel::items-changed</a></h6>
<div class="docblock">
<p>This signal is emitted whenever items were added to or removed
from <code>list</code>. At <code>position</code>, <code>removed</code> items were removed and <code>added</code>
items were added in their&nbsp;place.</p>
</div>
<div class="docblock">
<p><span class="emblem available-next" title="This signal will be available in the next stable release">unstable</span>&nbsp;<span class="emblem available">since: 2.44</span></p>
</div>
</div>
</div>
<div class="toggle-wrapper default-hide ancestor-signals"><h5 style="display:block;">Signals inherited from <a class="external" href="javascript:void(0)" data-link="iface.SelectionModel.html" data-namespace="Gtk">GtkSelectionModel</a> (1)</h5>
<div class="docblock">
<h6><a class="external" href="javascript:void(0)" data-namespace="Gtk" data-link="signal.SelectionModel.selection-changed.html">GtkSelectionModel::selection-changed</a></h6>
<div class="docblock">
<p>Emitted when the selection state of some of the items in <code>model</code> changes.</p>
</div>
<div class="docblock">
<p></p>
</div>
</div>
</div>
</div>
<div class="class toggle-wrapper default-hide">
<h4 id="class-struct">
Class structure
<a href="#class-struct" class="anchor"></a>
</h4>
<div class="docblock">
<pre><code>struct ClapperGtkQueueSelectionClass {
GObjectClass parent_class;
}</code></pre>
</div>
<div class="docblock">
No description available.
</div>
<div class="docblock">
<h6>Class members</h6>
<dl class="members">
<dt><code>parent_class: GObjectClass</code></dt>
<dd>No description available.</dd>
</dd>
</div>
</div>
</section>
</section>
<div id="toc" class="toc">
<nav aria-labelledby="toc-title">
<p id="toc-title">Content</p>
<ul class="toc-list">
<li class="toc-list-item"><a href="#description"><span class="link-text">Description</span></a></li>
<li class="toc-list-item"><a href="#hierarchy"><span class="link-text">Hierarchy</span></a></li>
<li class="toc-list-item"><a href="#ancestors"><span class="link-text">Ancestors</span></a></li>
<li class="toc-list-item"><a href="#implements"><span class="link-text">Implements</span></a></li>
<li class="toc-list-item"><a href="#constructors"><span class="link-text">Constructors</span></a></li>
<li class="toc-list-item"><a href="#methods"><span class="link-text">Methods</span></a></li>
<li class="toc-list-item"><a href="#properties"><span class="link-text">Properties</span></a></li>
<li class="toc-list-item"><a href="#signals"><span class="link-text">Signals</span></a></li>
</ul>
</nav>
</div>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>