/usr/share/gtk-doc/html/plank/Plank.DockElement.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 | <?xml version="1.0" encoding="utf-8"?>
<html>
<head>
<meta charset="UTF-8"/>
<title>Plank.DockElement – 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.DockElement – plank Reference Manual</div>
<div class="site_body">
<div class="site_content">
<h1 class="main_title">DockElement</h1>
<hr class="main_hr"/>
<h2 class="main_title">Object Hierarchy:</h2>
<img class="main_diagram" usemap="#Plank.DockElement" alt="Object hierarchy for DockElement" src="img/Plank.DockElement.png"/>
<map id="Plank.DockElement" name="Plank.DockElement">
<area shape="rect" id="node1" 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">DockElement</span></b> : <span class="main_type"><span class="class">Object</span></span>
</div>
<div class="description">
<p>The base class for all dock elements.</p>
</div>
<div class="box">
<div class="headline" onclick="toggle_box (this, 'box-content-53')">All known sub-classes:</div>
<div class="content" id="box-content-53">
<div class="column">
<ul class="navi_inline">
<li class="class"><a href="Plank.ApplicationDockItem.html">ApplicationDockItem</a></li>
<li class="class"><a href="Plank.ApplicationDockItemProvider.html">ApplicationDockItemProvider</a></li>
<li class="class"><a href="Plank.DefaultApplicationDockItemProvider.html">DefaultApplicationDockItemProvider</a></li>
<li class="abstract_class"><a href="Plank.DockContainer.html">DockContainer</a></li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="class"><a href="Plank.DockController.html">DockController</a></li>
<li class="abstract_class"><a href="Plank.DockItem.html">DockItem</a></li>
<li class="class"><a href="Plank.DockItemProvider.html">DockItemProvider</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>
<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_type"><a href="Plank.DockContainer.html" class="abstract_class">DockContainer</a></span>? <b><a href="Plank.DockElement.Container.html" class="property">Container</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 element's container which it is added too (if any).</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.DockElement.Text.html" class="property">Text</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 text.</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.DockElement.IsAttached.html" class="property">IsAttached</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">Whether the item is currently hidden on the dock. If TRUE it will be
drawn and does consume space. If FALSE it will not be drawn and does not consume space.</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.DockElement.IsVisible.html" class="property">IsVisible</a></b> { <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">Whether the item is currently visible on the dock. If TRUE it will be
drawn and does consume space. If FALSE it will not be drawn and does consume space.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.PopupButton.html" class="enum">PopupButton</a></span> <b><a href="Plank.DockElement.Button.html" class="property">Button</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 buttons this item shows popup menus for.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.AnimationType.html" class="enum">AnimationType</a></span> <b><a href="Plank.DockElement.ClickedAnimation.html" class="property">ClickedAnimation</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 animation to show for the item's last click event.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.AnimationType.html" class="enum">AnimationType</a></span> <b><a href="Plank.DockElement.HoveredAnimation.html" class="property">HoveredAnimation</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 animation to show for the item's last hover event.</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><a href="Plank.AnimationType.html" class="enum">AnimationType</a></span> <b><a href="Plank.DockElement.ScrolledAnimation.html" class="property">ScrolledAnimation</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 animation to show for the item's last scroll event.</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">int64</span></span> <b><a href="Plank.DockElement.AddTime.html" class="property">AddTime</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 time the item was added to 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">int64</span></span> <b><a href="Plank.DockElement.RemoveTime.html" class="property">RemoveTime</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 time the item was removed from 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">int64</span></span> <b><a href="Plank.DockElement.LastClicked.html" class="property">LastClicked</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 last time the item was clicked.</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">int64</span></span> <b><a href="Plank.DockElement.LastHovered.html" class="property">LastHovered</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 last time the item was hovered.</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">int64</span></span> <b><a href="Plank.DockElement.LastScrolled.html" class="property">LastScrolled</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 last time the item was scrolled.</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">int64</span></span> <b><a href="Plank.DockElement.LastUrgent.html" class="property">LastUrgent</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 last time the item changed its urgent status.</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">int64</span></span> <b><a href="Plank.DockElement.LastActive.html" class="property">LastActive</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 last time the item changed its active status.</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">int64</span></span> <b><a href="Plank.DockElement.LastMove.html" class="property">LastMove</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 last time the item changed its position.</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">int64</span></span> <b><a href="Plank.DockElement.LastValid.html" class="property">LastValid</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 last time the item was valid.</span>
</div></li>
</ul>
<h3 class="main_title">Static methods:</h3>
<ul class="navi_inline">
<li class="static_method"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">static</span> <span class="main_type"><span class="class">MenuItem</span></span> <b><a href="Plank.DockElement.create_menu_item.html" class="static_method">create_menu_item</a></b> (<span class="main_basic_type"><span class="class">string</span></span> title, <span class="main_basic_type"><span class="class">string</span></span>? icon = <span class="main_literal">null</span>, <span class="main_basic_type"><span class="struct">bool</span></span> force_show_icon = <span class="main_literal">false</span>)
</span>
<div class="leaf_brief_description"><span class="brief_description">Creates a new menu item.</span>
</div></li>
<li class="static_method"><span class="leaf_code_definition"><span class="main_keyword">protected</span> <span class="main_keyword">static</span> <span class="main_type"><span class="class">MenuItem</span></span> <b><a href="Plank.DockElement.create_menu_item_with_pixbuf.html" class="static_method">create_menu_item_with_pixbuf</a></b> (<span class="main_basic_type"><span class="class">string</span></span> title, <span class="main_keyword">owned</span> <span class="main_type"><span class="class">Pixbuf</span></span> pixbuf, <span class="main_basic_type"><span class="struct">bool</span></span> force_show_icon = <span class="main_literal">false</span>)
</span>
<div class="leaf_brief_description"><span class="brief_description">Creates a new menu 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.DockElement.DockElement.html" class="creation_method">DockElement</a></b> ()
</span>
<div class="leaf_brief_description">
</div></li>
</ul>
<h3 class="main_title">Methods:</h3>
<ul class="navi_inline">
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">void</span> <b><a href="Plank.DockElement.clicked.html" class="method">clicked</a></b> (<span class="main_type"><a href="Plank.PopupButton.html" class="enum">PopupButton</a></span> button, <span class="main_type"><span class="enum">ModifierType</span></span> mod, <span class="main_basic_type"><span class="struct">uint32</span></span> event_time)
</span>
<div class="leaf_brief_description"><span class="brief_description">Called when an item is clicked on.</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_type"><a href="Plank.AnimationType.html" class="enum">AnimationType</a></span> <b><a href="Plank.DockElement.on_clicked.html" class="virtual_method">on_clicked</a></b> (<span class="main_type"><a href="Plank.PopupButton.html" class="enum">PopupButton</a></span> button, <span class="main_type"><span class="enum">ModifierType</span></span> mod, <span class="main_basic_type"><span class="struct">uint32</span></span> event_time)
</span>
<div class="leaf_brief_description"><span class="brief_description">Called when an item is clicked on.</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.DockElement.hovered.html" class="method">hovered</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Called when an item gets hovered.</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_type"><a href="Plank.AnimationType.html" class="enum">AnimationType</a></span> <b><a href="Plank.DockElement.on_hovered.html" class="virtual_method">on_hovered</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Called when an item gets hovered.</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.DockElement.scrolled.html" class="method">scrolled</a></b> (<span class="main_type"><span class="enum">ScrollDirection</span></span> direction, <span class="main_type"><span class="enum">ModifierType</span></span> mod, <span class="main_basic_type"><span class="struct">uint32</span></span> event_time)
</span>
<div class="leaf_brief_description"><span class="brief_description">Called when an item is scrolled over.</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_type"><a href="Plank.AnimationType.html" class="enum">AnimationType</a></span> <b><a href="Plank.DockElement.on_scrolled.html" class="virtual_method">on_scrolled</a></b> (<span class="main_type"><span class="enum">ScrollDirection</span></span> direction, <span class="main_type"><span class="enum">ModifierType</span></span> mod, <span class="main_basic_type"><span class="struct">uint32</span></span> event_time)
</span>
<div class="leaf_brief_description"><span class="brief_description">Called when an item is scrolled over.</span>
</div></li>
<li class="method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">weak</span> <span class="main_type"><a href="Plank.DockController.html" class="class">DockController</a></span>? <b><a href="Plank.DockElement.get_dock.html" class="method">get_dock</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Get the dock which this element is part of</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_type"><span class="class">ArrayList</span></span><<span class="main_type"><span class="class">MenuItem</span></span>> <b><a href="Plank.DockElement.get_menu_items.html" class="virtual_method">get_menu_items</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns a list of the item's menu items.</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="class">string</span></span> <b><a href="Plank.DockElement.get_drop_text.html" class="virtual_method">get_drop_text</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">The item's text for drop actions.</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.DockElement.can_be_removed.html" class="virtual_method">can_be_removed</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns if this item can be removed from the dock.</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.DockElement.can_accept_drop.html" class="virtual_method">can_accept_drop</a></b> (<span class="main_type"><span class="class">ArrayList</span></span><<span class="main_basic_type"><span class="class">string</span></span>> uris)
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns if the item accepts a drop of the given URIs.</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.DockElement.accept_drop.html" class="virtual_method">accept_drop</a></b> (<span class="main_type"><span class="class">ArrayList</span></span><<span class="main_basic_type"><span class="class">string</span></span>> uris)
</span>
<div class="leaf_brief_description"><span class="brief_description">Accepts a drop of the given URIs.</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="class">string</span></span> <b><a href="Plank.DockElement.unique_id.html" class="virtual_method">unique_id</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns a unique ID for this dock item.</span>
</div></li>
<li class="method"><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.DockElement.as_uri.html" class="method">as_uri</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Returns a unique URI for this dock element.</span>
</div></li>
<li class="abstract_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">abstract</span> <span class="main_keyword">void</span> <b><a href="Plank.DockElement.reset_buffers.html" class="abstract_method">reset_buffers</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Resets the buffers for this element.</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.DockElement.needs_redraw.html" class="signal">needs_redraw</a></b> ()
</span>
<div class="leaf_brief_description"><span class="brief_description">Signal fired when the dock element needs redrawn.</span>
</div></li>
</ul>
<h3 class="main_title">Inherited Members:</h3>
<div class="box">
<div class="headline" onclick="toggle_box (this, 'box-content-54')">All known members inherited from class GLib.Object</div>
<div class="content" id="box-content-54">
<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>
|