mirror of
https://github.com/Rafostar/clapper.git
synced 2025-08-29 23:32:04 +02:00
241 lines
6.6 KiB
HTML
241 lines
6.6 KiB
HTML
<!--
|
|
SPDX-FileCopyrightText: Rafał Dzięgiel
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-or-later
|
|
-->
|
|
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>ClapperGtk.Billboard.pin_message</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 priority="og:title" content="ClapperGtk.Billboard.pin_message"/>
|
|
<meta priority="og:description" content="Reference for ClapperGtk.Billboard.pin_message"/>
|
|
<meta name="twitter:title" content="ClapperGtk.Billboard.pin_message"/>
|
|
<meta name="twitter:description" content="Reference for ClapperGtk.Billboard.pin_message"/>
|
|
|
|
|
|
|
|
<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">
|
|
<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">ClapperGtk</a></h3>
|
|
<p>API Version: 0.0</p>
|
|
|
|
<p>Library Version: 0.9.1</p>
|
|
|
|
</div>
|
|
|
|
<div class="section">
|
|
<h5>Type</h5>
|
|
<div class="links">
|
|
<a href="class.Billboard.html">Billboard</a>
|
|
</div>
|
|
</div>
|
|
<div class="section">
|
|
<h5>Methods</h5>
|
|
<div class="links">
|
|
|
|
<a class="method" href="method.Billboard.announce_speed.html">announce_speed</a>
|
|
|
|
<a class="method" href="method.Billboard.announce_volume.html">announce_volume</a>
|
|
|
|
<a class="method current" href="method.Billboard.pin_message.html">pin_message</a>
|
|
|
|
<a class="method" href="method.Billboard.post_message.html">post_message</a>
|
|
|
|
<a class="method" href="method.Billboard.unpin_pinned_message.html">unpin_pinned_message</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section generator">
|
|
<p>Generated by <a href="https://gitlab.gnome.org/GNOME/gi-docgen">gi-docgen</a> 2025.4</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">ClapperGtk</a><span class="sep"></span><a href="class.Billboard.html">Billboard</a><span class="sep"></span>pin_message</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-gtk/clapper-gtk-billboard.h#L47">[src]</a>
|
|
|
|
</h4>
|
|
|
|
<div class="docblock c-decl">
|
|
<pre><code><div class="highlight"><pre><span></span><span class="kt">void</span>
|
|
<span class="n">clapper_gtk_billboard_pin_message</span><span class="w"> </span><span class="p">(</span>
|
|
<span class="w"> </span><span class="n">ClapperGtkBillboard</span><span class="o">*</span><span class="w"> </span><span class="n">billboard</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">*</span><span class="w"> </span><span class="n">icon_name</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">gchar</span><span class="o">*</span><span class="w"> </span><span class="n">message</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-gtk/clapper-gtk-billboard.c#L247">[src]</a>
|
|
|
|
</h4>
|
|
|
|
<div class="docblock">
|
|
<p>Pins a permanent message on the <code>billboard</code>.</p>
|
|
<p>The message will stay on the <code>billboard</code> until a
|
|
<a href="method.Billboard.unpin_pinned_message.html"><code>clapper_gtk_billboard_unpin_pinned_message()</code></a> is called.</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>icon_name</code></dt>
|
|
<dd class="arg-description">
|
|
<p><em>Type:</em> <code>const gchar*</code></p>
|
|
<p>An icon name.</p>
|
|
<table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
|
|
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
|
|
<dt class="arg-name"><code>message</code></dt>
|
|
<dd class="arg-description">
|
|
<p><em>Type:</em> <code>const gchar*</code></p>
|
|
<p>A message text.</p>
|
|
<table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<tr><td title="transfer: none">The data is owned by the caller of the method.</td></tr>
|
|
<tr><td>The value is a NUL terminated UTF-8 string.</td></tr>
|
|
</table>
|
|
</dd>
|
|
|
|
|
|
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</section>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
<section id="search" class="content hidden"></section>
|
|
|
|
<footer>
|
|
|
|
</footer>
|
|
</div>
|
|
</body>
|
|
</html> |