/usr/share/gtk-doc/html/plank/Plank.DockItem.html is in libplank-doc 0.11.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 | <?xml version="1.0" encoding="utf-8"?>
<html>
<head>
<meta charset="UTF-8"/>
<title>Plank.DockItem – plank – Vala Binding Reference</title>
<link href="devhelpstyle.css" rel="stylesheet" type="text/css"/><script src="scripts.js" type="text/javascript">
</script>
</head>
<body>
<div class="site_header">Plank.DockItem – plank Reference Manual</div>
<div class="site_body">
<div class="site_content">
<h1 class="main_title">DockItem</h1>
<hr class="main_hr"/>
<h2 class="main_title">Object Hierarchy:</h2>
<img class="main_diagram" usemap="#Plank.DockItem" alt="Object hierarchy for DockItem" src="img/Plank.DockItem.png"/>
<map id="Plank.DockItem" name="Plank.DockItem">
<area shape="rect" id="node1" href="Plank.DockItem.html" title="Plank.DockItem" alt="" coords="19,197,160,245"/>
<area shape="rect" id="node2" href="Plank.DockElement.html" title="Plank.DockElement" alt="" coords="5,101,173,149"/>
</map>
<h2 class="main_title">Description:</h2>
<div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">abstract</span> <span class="main_keyword">class</span> <b><span class="abstract_class">DockItem</span></b> : <span class="main_type"><a href="Plank.DockElement.html" class="abstract_class">DockElement</a></span>
</div>
<div class="description">
<p>The base class for all dock items.</p>
</div>
<div class="box">
<div class="headline" onclick="toggle_box (this, 'box-content-55')">All known sub-classes:</div>
<div class="content" id="box-content-55">
<div class="column">
<ul class="navi_inline">
<li class="class"><a href="Plank.ApplicationDockItem.html">ApplicationDockItem</a></li>
<li class="abstract_class"><a href="Plank.DockletItem.html">DockletItem</a></li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="class"><a href="Plank.FileDockItem.html">FileDockItem</a></li>
<li class="class"><a href="Plank.PlaceholderDockItem.html">PlaceholderDockItem</a></li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="class"><a href="Plank.PlankDockItem.html">PlankDockItem</a></li>
<li class="class"><a href="Plank.TransientDockItem.html">TransientDockItem</a></li>
</ul>
</div>
</div>
</div><br/>
<div class="namespace_note"><b>Namespace:</b> <a href="Plank.html">Plank</a>
</div>
<div class="package_note"><b>Package:</b> <a href="index.htm">plank</a>
</div>
<h2 class="main_title">Content:</h2>
<h3 class="main_title">Properties:</h3>
<ul class="navi_inline">
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Plank.DockItem.Icon.html" class="property">Icon</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The dock item's icon.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_type"><span class="class">Pixbuf</span></span>? <b><a href="Plank.DockItem.ForcePixbuf.html" class="property">ForcePixbuf</a></b> { <span class="main_keyword">public</span> <span class="main_keyword">set</span>; <span class="main_keyword">public</span> <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description">
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">int64</span></span> <b><a href="Plank.DockItem.Count.html" class="property">Count</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The count for the dock item.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">bool</span></span> <b><a href="Plank.DockItem.CountVisible.html" class="property">CountVisible</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">Show the item's count or not.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">double</span></span> <b><a href="Plank.DockItem.Progress.html" class="property">Progress</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The progress for this dock item.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">bool</span></span> <b><a href="Plank.DockItem.ProgressVisible.html" class="property">ProgressVisible</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">Show the item's progress or not.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">int</span></span> <b><a href="Plank.DockItem.Position.html" class="property">Position</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The dock item's position on the dock.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="struct">int</span></span> <b><a href="Plank.DockItem.LastPosition.html" class="property">LastPosition</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The dock item's last position on the dock.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.ItemState.html" class="enum">ItemState</a></span> <b><a href="Plank.DockItem.State.html" class="property">State</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The item's current state.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.IndicatorState.html" class="enum">IndicatorState</a></span> <b><a href="Plank.DockItem.Indicator.html" class="property">Indicator</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The indicator shown for the item.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.Color.html" class="struct">Color</a></span> <b><a href="Plank.DockItem.AverageIconColor.html" class="property">AverageIconColor</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The average color of this item's icon.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Plank.DockItem.DockItemFilename.html" class="property">DockItemFilename</a></b> { <span class="main_keyword">owned</span> <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The filename of the preferences backing file.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Plank.DockItem.Launcher.html" class="property">Launcher</a></b> { <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The launcher associated with this item.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.DockItemPreferences.html" class="class">DockItemPreferences</a></span> <b><a href="Plank.DockItem.Prefs.html" class="property">Prefs</a></b> { <span class="main_keyword">construct</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">The underlying preferences for this item.</span>
</div></li>
</ul>
<h3 class="main_title">Creation methods:</h3>
<ul class="navi_inline">
<li class="creation_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <b><a href="Plank.DockItem.DockItem.html" class="creation_method">DockItem</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Creates a new dock item.</span>
</div></li>
</ul>
<h3 class="main_title">Methods:</h3>
<ul class="navi_inline">
<li class="virtual_method"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">virtual</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.load_from_launcher.html" class="virtual_method">load_from_launcher</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Parses the associated launcher and e.g. sets the icon and text from
it.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.@delete.html" class="method">@delete</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Deletes the underlying preferences file.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.reset_icon_buffer.html" class="method">reset_icon_buffer</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Resets the buffer for this item's icon and requests a redraw.</span>
</div></li>
<li class="virtual_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">override</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.reset_buffers.html" class="virtual_method">reset_buffers</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Resets the buffers for this item's icon.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.unset_move_state.html" class="method">unset_move_state</a></b> ()
</span>
<div class="leaf_brief_description">
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> <b><a href="Plank.DockItem.get_surface.html" class="method">get_surface</a></b> (<span class="main_basic_type"><span class="struct">int</span></span> width, <span class="main_basic_type"><span class="struct">int</span></span> height, <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> model)
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns the surface for this item.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span>? <b><a href="Plank.DockItem.get_background_surface.html" class="method">get_background_surface</a></b> (<span class="main_basic_type"><span class="struct">int</span></span> width, <span class="main_basic_type"><span class="struct">int</span></span> height, <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> model, <span class="main_type"><a href="Plank.DrawDataFunc.html" class="delegate">DrawDataFunc</a></span><<span class="main_type"><span class="abstract_class">DockItem</span></span>>? draw_data_func)
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns the background surface for this item.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span>? <b><a href="Plank.DockItem.get_foreground_surface.html" class="method">get_foreground_surface</a></b> (<span class="main_basic_type"><span class="struct">int</span></span> width, <span class="main_basic_type"><span class="struct">int</span></span> height, <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> model, <span class="main_type"><a href="Plank.DrawDataFunc.html" class="delegate">DrawDataFunc</a></span><<span class="main_type"><span class="abstract_class">DockItem</span></span>>? draw_data_func)
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns the foreground surface for this item.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> <b><a href="Plank.DockItem.get_surface_copy.html" class="method">get_surface_copy</a></b> (<span class="main_basic_type"><span class="struct">int</span></span> width, <span class="main_basic_type"><span class="struct">int</span></span> height, <span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> model)
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns a copy of the surface for this item.</span>
</div></li>
<li class="virtual_method"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">virtual</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.draw_icon.html" class="virtual_method">draw_icon</a></b> (<span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> surface)
</span>
<div class="leaf_brief_description"><span class="brief_description">Draws the item's icon onto a surface.</span>
</div></li>
<li class="virtual_method"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">virtual</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.draw_icon_fast.html" class="virtual_method">draw_icon_fast</a></b> (<span class="main_type"><a href="Plank.Surface.html" class="class">Surface</a></span> surface)
</span>
<div class="leaf_brief_description"><span class="brief_description">Draws a placeholder icon onto a surface. This method should be
considered time-critical! Make sure to only use simple drawing routines, and do not rely on external resources!</span>
</div></li>
<li class="virtual_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">virtual</span> <span class="main_basic_type"><span class="struct">bool</span></span> <b><a href="Plank.DockItem.is_valid.html" class="virtual_method">is_valid</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Check the validity of this item.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.copy_values_to.html" class="method">copy_values_to</a></b> (<span class="main_type"><span class="abstract_class">DockItem</span></span> target)
</span>
<div class="leaf_brief_description"><span class="brief_description">Copy all property value of this dockitem instance to target instance.
</span>
</div></li>
</ul>
<h3 class="main_title">Signals:</h3>
<ul class="navi_inline">
<li class="signal"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">signal</span> <span class="main_keyword">void</span> <b><a href="Plank.DockItem.deleted.html" class="signal">deleted</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Signal fired when the .dockitem for this item was deleted.</span>
</div></li>
</ul>
<h3 class="main_title">Inherited Members:</h3>
<div class="box">
<div class="headline" onclick="toggle_box (this, 'box-content-56')">All known members inherited from class Plank.DockElement</div>
<div class="content" id="box-content-56">
<div class="column">
<ul class="navi_inline">
<li class="property"><a href="Plank.DockElement.Container.html">Container</a></li>
<li class="property"><a href="Plank.DockElement.Text.html">Text</a></li>
<li class="property"><a href="Plank.DockElement.IsAttached.html">IsAttached</a></li>
<li class="property"><a href="Plank.DockElement.IsVisible.html">IsVisible</a></li>
<li class="property"><a href="Plank.DockElement.Button.html">Button</a></li>
<li class="property"><a href="Plank.DockElement.ClickedAnimation.html">ClickedAnimation</a></li>
<li class="property"><a href="Plank.DockElement.HoveredAnimation.html">HoveredAnimation</a></li>
<li class="property"><a href="Plank.DockElement.ScrolledAnimation.html">ScrolledAnimation</a></li>
<li class="property"><a href="Plank.DockElement.AddTime.html">AddTime</a></li>
<li class="property"><a href="Plank.DockElement.RemoveTime.html">RemoveTime</a></li>
<li class="property"><a href="Plank.DockElement.LastClicked.html">LastClicked</a></li>
<li class="property"><a href="Plank.DockElement.LastHovered.html">LastHovered</a></li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="property"><a href="Plank.DockElement.LastScrolled.html">LastScrolled</a></li>
<li class="property"><a href="Plank.DockElement.LastUrgent.html">LastUrgent</a></li>
<li class="property"><a href="Plank.DockElement.LastActive.html">LastActive</a></li>
<li class="property"><a href="Plank.DockElement.LastMove.html">LastMove</a></li>
<li class="property"><a href="Plank.DockElement.LastValid.html">LastValid</a></li>
<li class="static_method"><a href="Plank.DockElement.create_menu_item.html">create_menu_item</a></li>
<li class="static_method"><a href="Plank.DockElement.create_menu_item_with_pixbuf.html">create_menu_item_with_pixbuf</a></li>
<li class="method"><a href="Plank.DockElement.clicked.html">clicked</a></li>
<li class="virtual_method"><a href="Plank.DockElement.on_clicked.html">on_clicked</a></li>
<li class="method"><a href="Plank.DockElement.hovered.html">hovered</a></li>
<li class="virtual_method"><a href="Plank.DockElement.on_hovered.html">on_hovered</a></li>
<li class="method"><a href="Plank.DockElement.scrolled.html">scrolled</a></li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="virtual_method"><a href="Plank.DockElement.on_scrolled.html">on_scrolled</a></li>
<li class="method"><a href="Plank.DockElement.get_dock.html">get_dock</a></li>
<li class="virtual_method"><a href="Plank.DockElement.get_menu_items.html">get_menu_items</a></li>
<li class="virtual_method"><a href="Plank.DockElement.get_drop_text.html">get_drop_text</a></li>
<li class="virtual_method"><a href="Plank.DockElement.can_be_removed.html">can_be_removed</a></li>
<li class="virtual_method"><a href="Plank.DockElement.can_accept_drop.html">can_accept_drop</a></li>
<li class="virtual_method"><a href="Plank.DockElement.accept_drop.html">accept_drop</a></li>
<li class="virtual_method"><a href="Plank.DockElement.unique_id.html">unique_id</a></li>
<li class="method"><a href="Plank.DockElement.as_uri.html">as_uri</a></li>
<li class="abstract_method"><a href="Plank.DockElement.reset_buffers.html">reset_buffers</a></li>
<li class="signal"><a href="Plank.DockElement.needs_redraw.html">needs_redraw</a></li>
</ul>
</div>
</div>
</div>
<div class="box">
<div class="headline" onclick="toggle_box (this, 'box-content-57')">All known members inherited from class GLib.Object</div>
<div class="content" id="box-content-57">
<div class="column">
<ul class="navi_inline">
<li class="static_method">@new</li>
<li class="static_method">new_valist</li>
<li class="static_method">newv</li>
<li class="method">add_toggle_ref</li>
<li class="method">add_weak_pointer</li>
<li class="method">bind_property</li>
<li class="method">connect</li>
<li class="virtual_method">constructed</li>
<li class="method">disconnect</li>
<li class="virtual_method">dispose</li>
<li class="method">dup_data</li>
<li class="method">dup_qdata</li>
<li class="method">freeze_notify</li>
<li class="method">@get</li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="method">get_class</li>
<li class="method">get_data</li>
<li class="method">get_property</li>
<li class="method">get_qdata</li>
<li class="method">get_type</li>
<li class="method">notify_property</li>
<li class="method">@ref</li>
<li class="method">ref_sink</li>
<li class="method">replace_data</li>
<li class="method">replace_qdata</li>
<li class="method">remove_toggle_ref</li>
<li class="method">remove_weak_pointer</li>
<li class="method">@set</li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="method">set_data</li>
<li class="method">set_data_full</li>
<li class="method">set_property</li>
<li class="method">set_qdata</li>
<li class="method">set_qdata_full</li>
<li class="method">steal_data</li>
<li class="method">steal_qdata</li>
<li class="method">thaw_notify</li>
<li class="method">unref</li>
<li class="method">weak_ref</li>
<li class="method">weak_unref</li>
<li class="signal">notify</li>
<li class="field">ref_count</li>
</ul>
</div>
</div>
</div>
</div>
</div><br/>
<div class="site_footer">Generated by <a href="http://www.valadoc.org/">Valadoc</a>
</div>
</body>
</html>
|