Skip to content

Commit ca0d0d6

Browse files
committed
update doc
1 parent 227879e commit ca0d0d6

2 files changed

Lines changed: 35 additions & 24 deletions

File tree

content-docs/GnomeTools/reference/Gtk/R-ListModel.html

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
<link href="asset_files/images/favicon.ico" rel="icon" type="image/x-icon"/>
1010
<link rel="stylesheet" type="text/css" href="asset_files/css/rakudoc-extra.css" />
11-
<link rel="stylesheet" type="text/css" href="asset_files/css/rakudoc-styling.css" />
1211
<link rel="stylesheet" type="text/css" href="asset_files/css/font-awesome.min.css" />
12+
<link rel="stylesheet" type="text/css" href="asset_files/css/rakudoc-styling.css" />
1313

1414
</head>
1515
<body class="pod">
@@ -19,11 +19,13 @@
1919
<tr class="toc-level-1"><td class="toc-text"><a href="#Methods">Methods</a></td></tr>
2020
<tr class="toc-level-2"><td class="toc-text"><a href="#append">append</a></td></tr>
2121
<tr class="toc-level-2"><td class="toc-text"><a href="#find">find</a></td></tr>
22+
<tr class="toc-level-2"><td class="toc-text"><a href="#get-n-items">get-n-items</a></td></tr>
2223
<tr class="toc-level-2"><td class="toc-text"><a href="#get-selection">get-selection</a></td></tr>
2324
<tr class="toc-level-2"><td class="toc-text"><a href="#get-string">get-string</a></td></tr>
2425
<tr class="toc-level-2"><td class="toc-text"><a href="#remove">remove</a></td></tr>
2526
<tr class="toc-level-2"><td class="toc-text"><a href="#set-bind">set-bind</a></td></tr>
2627
<tr class="toc-level-2"><td class="toc-text"><a href="#set-events">set-events</a></td></tr>
28+
<tr class="toc-level-2"><td class="toc-text"><a href="#set-selection">set-selection</a></td></tr>
2729
<tr class="toc-level-2"><td class="toc-text"><a href="#set-selection-changed">set-selection-changed</a></td></tr>
2830
<tr class="toc-level-2"><td class="toc-text"><a href="#set-setup">set-setup</a></td></tr>
2931
<tr class="toc-level-2"><td class="toc-text"><a href="#set-teardown">set-teardown</a></td></tr>
@@ -37,31 +39,34 @@ <h1 id="Description"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go
3739
<h1 id="Methods"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">Methods</a></h1>
3840

3941
<h2 id="append"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">append</a></h2>
40-
<pre class="pod-block-code">method append ( *@list-item )
42+
<pre class="pod-block-code">method append ( *@items )
4143
</pre><ul>
42-
<li><p>@list-item; list item strings. The bind and unbind callback routines will receive these strings to properly fill in the data or remove it.</p></li>
44+
<li><p>@items; item strings. The bind and unbind callback routines will receive these strings to properly fill in the data or remove it.</p></li>
4345
</ul>
4446

4547
<h2 id="find"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">find</a></h2>
46-
<p>Find the position of the list item in the list.</p><pre class="pod-block-code">method find ( Str $list-item --&gt; UInt )
48+
<p>Find the position of the list item in the list.</p><pre class="pod-block-code">method find ( Str $item --&gt; UInt )
4749
</pre><ul>
48-
<li><p>$list-item; the string to look for.</p></li>
50+
<li><p>$item; the string to look for.</p></li>
4951
</ul>
50-
52+
<p>Returns the position of the string if found.</p>
53+
<h2 id="get-n-items"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">get-n-items</a></h2>
54+
<p>Get the number of items in the list.</p><pre class="pod-block-code">method get-n-items ( --&gt; UInt )
55+
</pre><p>Returns the number of items in the list.</p>
5156
<h2 id="get-selection"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">get-selection</a></h2>
52-
<p>Get the list of currently selected items</p><pre class="pod-block-code">method get-selection ( Bool :$rows = False --&gt; List )
57+
<p>Get the list of currently selected items.</p><pre class="pod-block-code">method get-selection ( Bool :$rows = False --&gt; List )
5358
</pre><ul>
5459
<li><p>$rows; When set, return the positions in the list, otherwise return a list of item strings.</p></li>
5560
</ul>
56-
61+
<p>Returns the list of currently selected items.</p>
5762
<h2 id="get-string"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">get-string</a></h2>
5863
<p>Get the list item string given the position in the list.</p><pre class="pod-block-code">method get-string ( UInt $pos --&gt; Str )
5964
</pre><ul>
6065
<li><p>$pos; the position in the list</p></li>
6166
</ul>
62-
67+
<pre class="pod-block-code">Returns the item string given the position in the list.</pre>
6368
<h2 id="remove"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">remove</a></h2>
64-
<p>Remove the list item given its position in the list.</p><pre class="pod-block-code">method remove ( @pos )
69+
<p>Remove the item given its position in the list.</p><pre class="pod-block-code">method remove ( *@pos )
6570
</pre><ul>
6671
<li><p>@pos; a list of positions to be removed</p></li>
6772
</ul>
@@ -83,6 +88,12 @@ <h2 id="set-bind"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to
8388
<h2 id="set-events"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">set-events</a></h2>
8489
<p>Register a series of events defined in the <strong>Gnome::Gtk4::SignalListItemFactory</strong> class. The purpose of this method is to register a series of events at once without the need of user methods to capture the events. The entries in the list are populated with <strong>Gnome::Gtk4::Label</strong>s. The text in the labels are set with user text from <code>.append()</code>.</p><pre class="pod-block-code">method set-events ( )
8590
</pre>
91+
<h2 id="set-selection"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">set-selection</a></h2>
92+
<p>Make selection changes.</p><pre class="pod-block-code">method set-selection ( *@pos )
93+
</pre><ul>
94+
<li><p>@pos; one or more positions in the list to select. If the model uses single selection, only one item is selected.</p></li>
95+
</ul>
96+
8697
<h2 id="set-selection-changed"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">set-selection-changed</a></h2>
8798
<p>The <code>selection-changed</code> event is emitted when the selection state of some of the items in the model changes.</p><pre class="pod-block-code">method set-selection-changed ( Any:D $object, Str:D $method, *%options )
8899
</pre><ul>
@@ -108,7 +119,7 @@ <h2 id="set-setup"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go t
108119
</pre><ul>
109120
<li><p>%options. Any named arguments provided to <code>.set-setup()</code>.</p></li>
110121
</ul>
111-
122+
<p>The callback routine must return the top leve widget.</p>
112123
<h2 id="set-teardown"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">set-teardown</a></h2>
113124
<p>The <code>teardown</code> event is emitted to undo the effects of the <code>setup</code> event. After this signal was emitted on a listitem, the listitem will be destroyed and not be used again. No <code>$item</code> is provided because the item is already destroyed. Any named arguments in <code>*%options</code> given to <code>.new()</code> are given to the method.</p><pre class="pod-block-code">method set-teardown ( Any:D $object, Str:D $method, *%options )
114125
</pre><ul>
@@ -137,13 +148,13 @@ <h2 id="set-unbind"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go
137148
</ul>
138149

139150
<h2 id="splice"><a href="#GnomeTools::Gtk::R-ListModel" class="u" title="go to top of document">splice</a></h2>
140-
<p>Remove list items at given position in the list. Then insert new items at that position.</p><pre class="pod-block-code">method splice ( UInt $pos, UInt $nremove, @str-array )
151+
<p>Remove list items at given position in the list. Then insert new items at that position.</p><pre class="pod-block-code">method splice ( UInt $pos, UInt $nremove, *@str-array )
141152
</pre><ul>
142153
<li><p>$pos; position in the list</p></li>
143154
<li><p>$nremove; number of list items to remove</p></li>
144-
<li><p>@str-array; list items to insert at position</p></li>
155+
<li><p>@str-array; list items to insert at the position</p></li>
145156
</ul>
146157
</section> </div>
147-
</div><footer><div>Rendered from <span class="path">/home/marcel/Languages/Raku/Projects/GnomeTools/lib/GnomeTools/Gtk/R-ListModel.rakudoc</span></div><div>at <span class="time">2026-01-28T21:20:03Z</span></div></footer>
158+
</div><footer><div>Rendered from <span class="path">/home/marcel/Languages/Raku/Projects/GnomeTools/lib/GnomeTools/Gtk/R-ListModel.rakudoc</span></div><div>at <span class="time">2026-02-25T13:45:31Z</span></div></footer>
148159
</body>
149160
</html>

content-docs/asset_files/css/rakudoc-extra.css

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,4 @@
11

2-
div.latex-render {
3-
display: flex;
4-
justify-content: space-around;
5-
align-items: center;
6-
}
7-
div.latex-render img.logo {
8-
align-self: center;
9-
}
10-
11-
122
.image-container {
133
display: flex;
144
width: 100%;
@@ -75,3 +65,13 @@ p.quotation .citation {
7565
div.flex-container {
7666
display: flex;
7767
}
68+
69+
div.latex-render {
70+
display: flex;
71+
justify-content: space-around;
72+
align-items: center;
73+
}
74+
div.latex-render img.logo {
75+
align-self: center;
76+
}
77+

0 commit comments

Comments
 (0)