Files
clapper/doc/clapper/method.Queue.select_index.html
github-actions[bot] 7aba8ae83f doc: Update
2025-06-19 10:45:20 +00:00

285 lines
7.7 KiB
HTML

<!--
SPDX-FileCopyrightText: Rafał Dzięgiel
SPDX-License-Identifier: LGPL-2.1-or-later
-->
<!DOCTYPE html>
<html lang="en">
<head>
<title>Clapper.Queue.select_index</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="Clapper-0.0"/>
<meta priority="og:title" content="Clapper.Queue.select_index"/>
<meta priority="og:description" content="Reference for Clapper.Queue.select_index"/>
<meta name="twitter:title" content="Clapper.Queue.select_index"/>
<meta name="twitter:description" content="Reference for Clapper.Queue.select_index"/>
<meta name="twitter:card" content="summary"/>
<link rel="search" type="application/opensearchdescription+xml" title="Clapper" 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">
<a href="index.html"><img src="clapper-logo.svg" class="logo"/></a>
</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">Clapper</a></h3>
<p>API Version: 0.0</p>
<p>Library Version: 0.9.0</p>
</div>
<div class="section">
<h5>Type</h5>
<div class="links">
<a href="class.Queue.html">Queue</a>
</div>
</div>
<div class="section">
<h5>Methods</h5>
<div class="links">
<a class="method" href="method.Queue.add_item.html">add_item</a>
<a class="method" href="method.Queue.clear.html">clear</a>
<a class="method" href="method.Queue.find_item.html">find_item</a>
<a class="method" href="method.Queue.get_current_index.html">get_current_index</a>
<a class="method" href="method.Queue.get_current_item.html">get_current_item</a>
<a class="method" href="method.Queue.get_gapless.html">get_gapless</a>
<a class="method" href="method.Queue.get_instant.html">get_instant</a>
<a class="method" href="method.Queue.get_item.html">get_item</a>
<a class="method" href="method.Queue.get_n_items.html">get_n_items</a>
<a class="method" href="method.Queue.get_progression_mode.html">get_progression_mode</a>
<a class="method" href="method.Queue.insert_item.html">insert_item</a>
<a class="method" href="method.Queue.item_is_current.html">item_is_current</a>
<a class="method" href="method.Queue.remove_index.html">remove_index</a>
<a class="method" href="method.Queue.remove_item.html">remove_item</a>
<a class="method" href="method.Queue.reposition_item.html">reposition_item</a>
<a class="method current" href="method.Queue.select_index.html">select_index</a>
<a class="method" href="method.Queue.select_item.html">select_item</a>
<a class="method" href="method.Queue.select_next_item.html">select_next_item</a>
<a class="method" href="method.Queue.select_previous_item.html">select_previous_item</a>
<a class="method" href="method.Queue.set_gapless.html">set_gapless</a>
<a class="method" href="method.Queue.set_instant.html">set_instant</a>
<a class="method" href="method.Queue.set_progression_mode.html">set_progression_mode</a>
<a class="method" href="method.Queue.steal_index.html">steal_index</a>
</div>
</div>
<div class="section generator">
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2025.3</p>
</div>
</nav>
<button id="btn-to-top" class="hidden"><span class="up-arrow"></span></button>
<section id="main" class="content">
<header>
<h3>Method</h3>
<h1><a href="index.html">Clapper</a><span class="sep"></span><a href="class.Queue.html">Queue</a><span class="sep"></span>select_index</h1>
</header>
<section>
<div class="docblock">
<p></p>
</div>
<div class="declaration toggle-wrapper">
<h4 style="display:flex;" id="declaration">
Declaration
<a class="anchor" href="#declaration"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/src/lib/clapper/clapper-queue.h#L73">[src]</a>
</h4>
<div class="docblock c-decl">
<pre><code><div class="highlight"><pre><span></span><span class="n">gboolean</span>
<span class="n">clapper_queue_select_index</span><span class="w"> </span><span class="p">(</span>
<span class="w"> </span><span class="n">ClapperQueue</span><span class="o">*</span><span class="w"> </span><span class="n">queue</span><span class="p">,</span>
<span class="w"> </span><span class="n">guint</span><span class="w"> </span><span class="n">index</span>
<span class="p">)</span>
</pre></div>
</code></pre>
</div>
</div>
<div class="description toggle-wrapper">
<h4 style="display:flex;" id="description">
Description
<a class="anchor" href="#description"></a>
<a class="srclink" title="go to source location" href="https://github.com/Rafostar/clapper/tree/master/src/lib/clapper/clapper-queue.c#L728">[src]</a>
</h4>
<div class="docblock">
<p>Selects <code>ClapperMediaItem</code> at <code>index</code> from <code>queue</code> as current one or
unselects currently selected index when <code>index</code> is <a href="const.QUEUE_INVALID_POSITION.html"><code>CLAPPER_QUEUE_INVALID_POSITION</code></a>.</p>
</div>
<div class="docblock">
</div>
</div>
<div class="parameters toggle-wrapper">
<h4 id="parameters">
Parameters
<a href="#parameters" class="anchor"></a>
</h4>
<div class="docblock">
<dl class="arguments">
<dt class="arg-name"><code>index</code></dt>
<dd class="arg-description">
<p><em>Type:</em>&nbsp;<code>guint</code></p>
<p>An item index or <a href="const.QUEUE_INVALID_POSITION.html"><code>CLAPPER_QUEUE_INVALID_POSITION</code></a> to&nbsp;unselect.</p>
<table>
</table>
</dd>
</dl>
</div>
</div>
<div class="return-value toggle-wrapper">
<h4 id="return-value">
Return value
<a href="#return-value" class="anchor"></a>
</h4>
<div class="docblock">
<div class="returns">
<div class="arg-description">
<p><em>Type:</em>&nbsp;<code>gboolean</code></p>
<p><code>TRUE</code> if item at <code>index</code> could be selected/unselected,
<code>FALSE</code> if index was out of queue&nbsp;range.</p>
</div>
<div>
<table>
</table>
</div>
</div>
</div>
</div>
</section>
</section>
<section id="search" class="content hidden"></section>
<footer>
</footer>
</div>
</body>
</html>