<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXDockBar
— FXRuby API Documentation
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Fox::FXDockBar";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (F)</a> »
<span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
»
<span class="title">FXDockBar</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Fox::FXDockBar
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXPacker.html" title="Fox::FXPacker (class)">FXPacker</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span></li>
<li class="next"><span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></li>
<li class="next"><span class='object_link'><a href="FXDrawable.html" title="Fox::FXDrawable (class)">FXDrawable</a></span></li>
<li class="next"><span class='object_link'><a href="FXWindow.html" title="Fox::FXWindow (class)">FXWindow</a></span></li>
<li class="next"><span class='object_link'><a href="FXComposite.html" title="Fox::FXComposite (class)">FXComposite</a></span></li>
<li class="next"><span class='object_link'><a href="FXPacker.html" title="Fox::FXPacker (class)">FXPacker</a></span></li>
<li class="next">Fox::FXDockBar</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXDockBar.rb<span class="defines">,<br />
lib/fox16/core.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A dock bar widget can be docked inside a dock site widget, or floated around freely. Users can move, undock, and dock the dock bar widget by means of a handle such as a tool bar grip. When docking, the dock bar sends a <code>SEL_DOCKED</code> message to its target; when undocking, it sends a <code>SEL_FLOATED</code> message. In either case the dock site involved is passed as the message data.</p>
<h3 id="label-Events">Events</h3>
<p>The following messages are sent by FXDockBar to its target:</p>
<dl class="rdoc-list note-list"><dt><code>SEL_DOCKED</code>
<dd>
<p>sent when the dock bar is docked; the message data is a reference to the new dock site (an FXDockSite instance).</p>
</dd><dt><code>SEL_FLOATED</code>
<dd>
<p>sent when the dock bar is undocked; the message data is a reference to the previous dock site.</p>
</dd></dl>
<h3 id="label-Dock+Bar+Options">Dock Bar Options</h3>
<dl class="rdoc-list note-list"><dt><code>ALLOW_NOWHERE</code>
<dd>
<p>Don’t allow docking anywhere</p>
</dd><dt><code>ALLOW_TOP</code>
<dd>
<p>Docking at the top only</p>
</dd><dt><code>ALLOW_BOTTOM</code>
<dd>
<p>Docking at the bottom only</p>
</dd><dt><code>ALLOW_LEFT</code>
<dd>
<p>Docking at the left only</p>
</dd><dt><code>ALLOW_RIGHT</code>
<dd>
<p>Docking at the right only</p>
</dd><dt><code>ALLOW_HORIZONTAL</code>
<dd>
<p>Docking at the top and bottom</p>
</dd><dt><code>ALLOW_VERTICAL</code>
<dd>
<p>Docking at the left and right</p>
</dd><dt><code>ALLOW_EVERYWHERE</code>
<dd>
<p>Docking can be everywhere</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="FXToolBar.html" title="Fox::FXToolBar (class)">FXToolBar</a></span></p>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#dockingSide-instance_method" title="#dockingSide (instance method)">#<strong>dockingSide</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Docking side, one of <code>LAYOUT_SIDE_LEFT</code>, <code>LAYOUT_SIDE_RIGHT</code>, <code>LAYOUT_SIDE_TOP</code> or <code>LAYOUT_SIDE_BOTTOM</code> [Integer].</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXPacker.html" title="Fox::FXPacker (class)">FXPacker</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXPacker.html#baseColor-instance_method" title="Fox::FXPacker#baseColor (method)">#baseColor</a></span>, <span class='object_link'><a href="FXPacker.html#borderColor-instance_method" title="Fox::FXPacker#borderColor (method)">#borderColor</a></span>, <span class='object_link'><a href="FXPacker.html#borderWidth-instance_method" title="Fox::FXPacker#borderWidth (method)">#borderWidth</a></span>, <span class='object_link'><a href="FXPacker.html#frameStyle-instance_method" title="Fox::FXPacker#frameStyle (method)">#frameStyle</a></span>, <span class='object_link'><a href="FXPacker.html#hSpacing-instance_method" title="Fox::FXPacker#hSpacing (method)">#hSpacing</a></span>, <span class='object_link'><a href="FXPacker.html#hiliteColor-instance_method" title="Fox::FXPacker#hiliteColor (method)">#hiliteColor</a></span>, <span class='object_link'><a href="FXPacker.html#packingHints-instance_method" title="Fox::FXPacker#packingHints (method)">#packingHints</a></span>, <span class='object_link'><a href="FXPacker.html#padBottom-instance_method" title="Fox::FXPacker#padBottom (method)">#padBottom</a></span>, <span class='object_link'><a href="FXPacker.html#padLeft-instance_method" title="Fox::FXPacker#padLeft (method)">#padLeft</a></span>, <span class='object_link'><a href="FXPacker.html#padRight-instance_method" title="Fox::FXPacker#padRight (method)">#padRight</a></span>, <span class='object_link'><a href="FXPacker.html#padTop-instance_method" title="Fox::FXPacker#padTop (method)">#padTop</a></span>, <span class='object_link'><a href="FXPacker.html#shadowColor-instance_method" title="Fox::FXPacker#shadowColor (method)">#shadowColor</a></span>, <span class='object_link'><a href="FXPacker.html#vSpacing-instance_method" title="Fox::FXPacker#vSpacing (method)">#vSpacing</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXWindow.html" title="Fox::FXWindow (class)">FXWindow</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXWindow.html#accelTable-instance_method" title="Fox::FXWindow#accelTable (method)">#accelTable</a></span>, <span class='object_link'><a href="FXWindow.html#backColor-instance_method" title="Fox::FXWindow#backColor (method)">#backColor</a></span>, <span class='object_link'><a href="FXWindow.html#defaultCursor-instance_method" title="Fox::FXWindow#defaultCursor (method)">#defaultCursor</a></span>, <span class='object_link'><a href="FXWindow.html#dragCursor-instance_method" title="Fox::FXWindow#dragCursor (method)">#dragCursor</a></span>, <span class='object_link'><a href="FXWindow.html#first-instance_method" title="Fox::FXWindow#first (method)">#first</a></span>, <span class='object_link'><a href="FXWindow.html#focus-instance_method" title="Fox::FXWindow#focus (method)">#focus</a></span>, <span class='object_link'><a href="FXWindow.html#key-instance_method" title="Fox::FXWindow#key (method)">#key</a></span>, <span class='object_link'><a href="FXWindow.html#last-instance_method" title="Fox::FXWindow#last (method)">#last</a></span>, <span class='object_link'><a href="FXWindow.html#layoutHints-instance_method" title="Fox::FXWindow#layoutHints (method)">#layoutHints</a></span>, <span class='object_link'><a href="FXWindow.html#next-instance_method" title="Fox::FXWindow#next (method)">#next</a></span>, <span class='object_link'><a href="FXWindow.html#numChildren-instance_method" title="Fox::FXWindow#numChildren (method)">#numChildren</a></span>, <span class='object_link'><a href="FXWindow.html#owner-instance_method" title="Fox::FXWindow#owner (method)">#owner</a></span>, <span class='object_link'><a href="FXWindow.html#parent-instance_method" title="Fox::FXWindow#parent (method)">#parent</a></span>, <span class='object_link'><a href="FXWindow.html#prev-instance_method" title="Fox::FXWindow#prev (method)">#prev</a></span>, <span class='object_link'><a href="FXWindow.html#root-instance_method" title="Fox::FXWindow#root (method)">#root</a></span>, <span class='object_link'><a href="FXWindow.html#selector-instance_method" title="Fox::FXWindow#selector (method)">#selector</a></span>, <span class='object_link'><a href="FXWindow.html#shell-instance_method" title="Fox::FXWindow#shell (method)">#shell</a></span>, <span class='object_link'><a href="FXWindow.html#target-instance_method" title="Fox::FXWindow#target (method)">#target</a></span>, <span class='object_link'><a href="FXWindow.html#x-instance_method" title="Fox::FXWindow#x (method)">#x</a></span>, <span class='object_link'><a href="FXWindow.html#y-instance_method" title="Fox::FXWindow#y (method)">#y</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXDrawable.html" title="Fox::FXDrawable (class)">FXDrawable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXDrawable.html#height-instance_method" title="Fox::FXDrawable#height (method)">#height</a></span>, <span class='object_link'><a href="FXDrawable.html#visual-instance_method" title="Fox::FXDrawable#visual (method)">#visual</a></span>, <span class='object_link'><a href="FXDrawable.html#width-instance_method" title="Fox::FXDrawable#width (method)">#width</a></span></p>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#app-instance_method" title="Fox::FXId#app (method)">#app</a></span>, <span class='object_link'><a href="FXId.html#userData-instance_method" title="Fox::FXId#userData (method)">#userData</a></span>, <span class='object_link'><a href="FXId.html#xid-instance_method" title="Fox::FXId#xid (method)">#xid</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#allowedSide%3F-instance_method" title="#allowedSide? (instance method)">#<strong>allowedSide?</strong>(side) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if docking is allowed on the specified side, where <em>side</em> is one of the <code>ALLOW</code> constants listed above.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#allowedSides-instance_method" title="#allowedSides (instance method)">#<strong>allowedSides</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return set of sides where docking is allowed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#allowedSides=-instance_method" title="#allowedSides= (instance method)">#<strong>allowedSides=</strong>(allowed) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Change set of sides (a combination of <code>ALLOW_TOP</code>, <code>ALLOW_LEFT</code>, etc.), where docking is allowed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#allowSide-instance_method" title="#allowSide (instance method)">#<strong>allowSide</strong>(side) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Allow docking on the specified side, where <em>side</em> is one of the <code>ALLOW</code> constants listed above.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#disallowSide-instance_method" title="#disallowSide (instance method)">#<strong>disallowSide</strong>(side) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Disallow docking on the specified side, where <em>side</em> is one of the <code>ALLOW</code> constants listed above.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dock-instance_method" title="#dock (instance method)">#<strong>dock</strong>(docksite, local_x, local_y, notify) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Dock the bar against the given side, near the given position relative to the toolbar dock’s origin.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#docked%3F-instance_method" title="#docked? (instance method)">#<strong>docked?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if docked.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dryDock-instance_method" title="#dryDock (instance method)">#<strong>dryDock</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return parent when docked.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#dryDock=-instance_method" title="#dryDock= (instance method)">#<strong>dryDock=</strong>(dry) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set parent when docked.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#findDockAtSide-instance_method" title="#findDockAtSide (instance method)">#<strong>findDockAtSide</strong>(side = LAYOUT_SIDE_TOP) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Search for dock against given side of main window.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#findDockNear-instance_method" title="#findDockNear (instance method)">#<strong>findDockNear</strong>(root_x, root_y) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Search for dock close to coordinates (<em>root_x</em>, <em>root_y</em>).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(p, opts = LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x = 0, y = 0, width = 0, height = 0, padLeft = 3, padRight = 3, padTop = 2, padBottom = 2, hSpacing = DEFAULT_SPACING, vSpacing = DEFAULT_SPACING) ⇒ FXDockBar </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Construct a non-floatable dock bar.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#insideDock%3F-instance_method" title="#insideDock? (instance method)">#<strong>insideDock?</strong>(docksite, barx, bary) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return <code>true</code> if the dock bar would dock or undock if at locaton (<em>barx</em>, <em>bary</em>).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#undock-instance_method" title="#undock (instance method)">#<strong>undock</strong>(root_x, root_y, notify = false) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Undock or float the bar.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wetDock-instance_method" title="#wetDock (instance method)">#<strong>wetDock</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Return parent when floating.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wetDock=-instance_method" title="#wetDock= (instance method)">#<strong>wetDock=</strong>(wet) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Set parent when floating.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXComposite.html" title="Fox::FXComposite (class)">FXComposite</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXComposite.html#maxChildHeight-instance_method" title="Fox::FXComposite#maxChildHeight (method)">#maxChildHeight</a></span>, <span class='object_link'><a href="FXComposite.html#maxChildWidth-instance_method" title="Fox::FXComposite#maxChildWidth (method)">#maxChildWidth</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXWindow.html" title="Fox::FXWindow (class)">FXWindow</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXWindow.html#acceptDrop-instance_method" title="Fox::FXWindow#acceptDrop (method)">#acceptDrop</a></span>, <span class='object_link'><a href="FXWindow.html#acquireClipboard-instance_method" title="Fox::FXWindow#acquireClipboard (method)">#acquireClipboard</a></span>, <span class='object_link'><a href="FXWindow.html#acquireSelection-instance_method" title="Fox::FXWindow#acquireSelection (method)">#acquireSelection</a></span>, <span class='object_link'><a href="FXWindow.html#active%3F-instance_method" title="Fox::FXWindow#active? (method)">#active?</a></span>, <span class='object_link'><a href="FXWindow.html#addHotKey-instance_method" title="Fox::FXWindow#addHotKey (method)">#addHotKey</a></span>, <span class='object_link'><a href="FXWindow.html#after%3F-class_method" title="Fox::FXWindow.after? (method)">after?</a></span>, <span class='object_link'><a href="FXWindow.html#after%3F-instance_method" title="Fox::FXWindow#after? (method)">#after?</a></span>, <span class='object_link'><a href="FXWindow.html#before%3F-class_method" title="Fox::FXWindow.before? (method)">before?</a></span>, <span class='object_link'><a href="FXWindow.html#before%3F-instance_method" title="Fox::FXWindow#before? (method)">#before?</a></span>, <span class='object_link'><a href="FXWindow.html#beginDrag-instance_method" title="Fox::FXWindow#beginDrag (method)">#beginDrag</a></span>, <span class='object_link'><a href="FXWindow.html#canFocus%3F-instance_method" title="Fox::FXWindow#canFocus? (method)">#canFocus?</a></span>, <span class='object_link'><a href="FXWindow.html#changeFocus-instance_method" title="Fox::FXWindow#changeFocus (method)">#changeFocus</a></span>, <span class='object_link'><a href="FXWindow.html#childAtIndex-instance_method" title="Fox::FXWindow#childAtIndex (method)">#childAtIndex</a></span>, <span class='object_link'><a href="FXWindow.html#childOf%3F-instance_method" title="Fox::FXWindow#childOf? (method)">#childOf?</a></span>, <span class='object_link'><a href="FXWindow.html#children-instance_method" title="Fox::FXWindow#children (method)">#children</a></span>, <span class='object_link'><a href="FXWindow.html#clearDragRectangle-instance_method" title="Fox::FXWindow#clearDragRectangle (method)">#clearDragRectangle</a></span>, <span class='object_link'><a href="FXWindow.html#clearShape-instance_method" title="Fox::FXWindow#clearShape (method)">#clearShape</a></span>, <span class='object_link'><a href="FXWindow.html#colorType-class_method" title="Fox::FXWindow.colorType (method)">colorType</a></span>, <span class='object_link'><a href="FXWindow.html#colorTypeName-class_method" title="Fox::FXWindow.colorTypeName (method)">colorTypeName</a></span>, <span class='object_link'><a href="FXWindow.html#commonAncestor-class_method" title="Fox::FXWindow.commonAncestor (method)">commonAncestor</a></span>, <span class='object_link'><a href="FXWindow.html#composeContext-instance_method" title="Fox::FXWindow#composeContext (method)">#composeContext</a></span>, <span class='object_link'><a href="FXWindow.html#composite%3F-instance_method" title="Fox::FXWindow#composite? (method)">#composite?</a></span>, <span class='object_link'><a href="FXWindow.html#contains%3F-instance_method" title="Fox::FXWindow#contains? (method)">#contains?</a></span>, <span class='object_link'><a href="FXWindow.html#containsChild%3F-instance_method" title="Fox::FXWindow#containsChild? (method)">#containsChild?</a></span>, <span class='object_link'><a href="FXWindow.html#create-instance_method" title="Fox::FXWindow#create (method)">#create</a></span>, <span class='object_link'><a href="FXWindow.html#createComposeContext-instance_method" title="Fox::FXWindow#createComposeContext (method)">#createComposeContext</a></span>, <span class='object_link'><a href="FXWindow.html#cursorPosition-instance_method" title="Fox::FXWindow#cursorPosition (method)">#cursorPosition</a></span>, <span class='object_link'><a href="FXWindow.html#default%3F-instance_method" title="Fox::FXWindow#default? (method)">#default?</a></span>, <span class='object_link'><a href="FXWindow.html#defaultHeight-instance_method" title="Fox::FXWindow#defaultHeight (method)">#defaultHeight</a></span>, <span class='object_link'><a href="FXWindow.html#defaultWidth-instance_method" title="Fox::FXWindow#defaultWidth (method)">#defaultWidth</a></span>, <span class='object_link'><a href="FXWindow.html#deleteType-class_method" title="Fox::FXWindow.deleteType (method)">deleteType</a></span>, <span class='object_link'><a href="FXWindow.html#deleteTypeName-class_method" title="Fox::FXWindow.deleteTypeName (method)">deleteTypeName</a></span>, <span class='object_link'><a href="FXWindow.html#destroy-instance_method" title="Fox::FXWindow#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="FXWindow.html#destroyComposeContext-instance_method" title="Fox::FXWindow#destroyComposeContext (method)">#destroyComposeContext</a></span>, <span class='object_link'><a href="FXWindow.html#detach-instance_method" title="Fox::FXWindow#detach (method)">#detach</a></span>, <span class='object_link'><a href="FXWindow.html#didAccept-instance_method" title="Fox::FXWindow#didAccept (method)">#didAccept</a></span>, <span class='object_link'><a href="FXWindow.html#disable-instance_method" title="Fox::FXWindow#disable (method)">#disable</a></span>, <span class='object_link'><a href="FXWindow.html#doesSaveUnder%3F-instance_method" title="Fox::FXWindow#doesSaveUnder? (method)">#doesSaveUnder?</a></span>, <span class='object_link'><a href="FXWindow.html#dragging%3F-instance_method" title="Fox::FXWindow#dragging? (method)">#dragging?</a></span>, <span class='object_link'><a href="FXWindow.html#dropDisable-instance_method" title="Fox::FXWindow#dropDisable (method)">#dropDisable</a></span>, <span class='object_link'><a href="FXWindow.html#dropEnable-instance_method" title="Fox::FXWindow#dropEnable (method)">#dropEnable</a></span>, <span class='object_link'><a href="FXWindow.html#dropEnabled%3F-instance_method" title="Fox::FXWindow#dropEnabled? (method)">#dropEnabled?</a></span>, <span class='object_link'><a href="FXWindow.html#dropFinished-instance_method" title="Fox::FXWindow#dropFinished (method)">#dropFinished</a></span>, <span class='object_link'><a href="FXWindow.html#dropTarget%3F-instance_method" title="Fox::FXWindow#dropTarget? (method)">#dropTarget?</a></span>, <span class='object_link'><a href="FXWindow.html#each_child-instance_method" title="Fox::FXWindow#each_child (method)">#each_child</a></span>, <span class='object_link'><a href="FXWindow.html#each_child_recursive-instance_method" title="Fox::FXWindow#each_child_recursive (method)">#each_child_recursive</a></span>, <span class='object_link'><a href="FXWindow.html#enable-instance_method" title="Fox::FXWindow#enable (method)">#enable</a></span>, <span class='object_link'><a href="FXWindow.html#enabled%3F-instance_method" title="Fox::FXWindow#enabled? (method)">#enabled?</a></span>, <span class='object_link'><a href="FXWindow.html#endDrag-instance_method" title="Fox::FXWindow#endDrag (method)">#endDrag</a></span>, <span class='object_link'><a href="FXWindow.html#forceRefresh-instance_method" title="Fox::FXWindow#forceRefresh (method)">#forceRefresh</a></span>, <span class='object_link'><a href="FXWindow.html#getChildAt-instance_method" title="Fox::FXWindow#getChildAt (method)">#getChildAt</a></span>, <span class='object_link'><a href="FXWindow.html#getDNDData-instance_method" title="Fox::FXWindow#getDNDData (method)">#getDNDData</a></span>, <span class='object_link'><a href="FXWindow.html#getHeightForWidth-instance_method" title="Fox::FXWindow#getHeightForWidth (method)">#getHeightForWidth</a></span>, <span class='object_link'><a href="FXWindow.html#getWidthForHeight-instance_method" title="Fox::FXWindow#getWidthForHeight (method)">#getWidthForHeight</a></span>, <span class='object_link'><a href="FXWindow.html#grab-instance_method" title="Fox::FXWindow#grab (method)">#grab</a></span>, <span class='object_link'><a href="FXWindow.html#grabKeyboard-instance_method" title="Fox::FXWindow#grabKeyboard (method)">#grabKeyboard</a></span>, <span class='object_link'><a href="FXWindow.html#grabbed%3F-instance_method" title="Fox::FXWindow#grabbed? (method)">#grabbed?</a></span>, <span class='object_link'><a href="FXWindow.html#grabbedKeyboard%3F-instance_method" title="Fox::FXWindow#grabbedKeyboard? (method)">#grabbedKeyboard?</a></span>, <span class='object_link'><a href="FXWindow.html#handleDrag-instance_method" title="Fox::FXWindow#handleDrag (method)">#handleDrag</a></span>, <span class='object_link'><a href="FXWindow.html#hasClipboard%3F-instance_method" title="Fox::FXWindow#hasClipboard? (method)">#hasClipboard?</a></span>, <span class='object_link'><a href="FXWindow.html#hasFocus%3F-instance_method" title="Fox::FXWindow#hasFocus? (method)">#hasFocus?</a></span>, <span class='object_link'><a href="FXWindow.html#hasSelection%3F-instance_method" title="Fox::FXWindow#hasSelection? (method)">#hasSelection?</a></span>, <span class='object_link'><a href="FXWindow.html#height-instance_method" title="Fox::FXWindow#height (method)">#height</a></span>, <span class='object_link'><a href="FXWindow.html#height=-instance_method" title="Fox::FXWindow#height= (method)">#height=</a></span>, <span class='object_link'><a href="FXWindow.html#hide-instance_method" title="Fox::FXWindow#hide (method)">#hide</a></span>, <span class='object_link'><a href="FXWindow.html#imageType-class_method" title="Fox::FXWindow.imageType (method)">imageType</a></span>, <span class='object_link'><a href="FXWindow.html#inFocusChain%3F-instance_method" title="Fox::FXWindow#inFocusChain? (method)">#inFocusChain?</a></span>, <span class='object_link'><a href="FXWindow.html#indexOfChild-instance_method" title="Fox::FXWindow#indexOfChild (method)">#indexOfChild</a></span>, <span class='object_link'><a href="FXWindow.html#initial%3F-instance_method" title="Fox::FXWindow#initial? (method)">#initial?</a></span>, <span class='object_link'><a href="FXWindow.html#inquireDNDAction-instance_method" title="Fox::FXWindow#inquireDNDAction (method)">#inquireDNDAction</a></span>, <span class='object_link'><a href="FXWindow.html#inquireDNDTypes-instance_method" title="Fox::FXWindow#inquireDNDTypes (method)">#inquireDNDTypes</a></span>, <span class='object_link'><a href="FXWindow.html#killFocus-instance_method" title="Fox::FXWindow#killFocus (method)">#killFocus</a></span>, <span class='object_link'><a href="FXWindow.html#layout-instance_method" title="Fox::FXWindow#layout (method)">#layout</a></span>, <span class='object_link'><a href="FXWindow.html#linkAfter-instance_method" title="Fox::FXWindow#linkAfter (method)">#linkAfter</a></span>, <span class='object_link'><a href="FXWindow.html#linkBefore-instance_method" title="Fox::FXWindow#linkBefore (method)">#linkBefore</a></span>, <span class='object_link'><a href="FXWindow.html#lower-instance_method" title="Fox::FXWindow#lower (method)">#lower</a></span>, <span class='object_link'><a href="FXWindow.html#move-instance_method" title="Fox::FXWindow#move (method)">#move</a></span>, <span class='object_link'><a href="FXWindow.html#octetType-class_method" title="Fox::FXWindow.octetType (method)">octetType</a></span>, <span class='object_link'><a href="FXWindow.html#octetTypeName-class_method" title="Fox::FXWindow.octetTypeName (method)">octetTypeName</a></span>, <span class='object_link'><a href="FXWindow.html#offeredDNDType%3F-instance_method" title="Fox::FXWindow#offeredDNDType? (method)">#offeredDNDType?</a></span>, <span class='object_link'><a href="FXWindow.html#position-instance_method" title="Fox::FXWindow#position (method)">#position</a></span>, <span class='object_link'><a href="FXWindow.html#raiseWindow-instance_method" title="Fox::FXWindow#raiseWindow (method)">#raiseWindow</a></span>, <span class='object_link'><a href="FXWindow.html#recalc-instance_method" title="Fox::FXWindow#recalc (method)">#recalc</a></span>, <span class='object_link'><a href="FXWindow.html#releaseClipboard-instance_method" title="Fox::FXWindow#releaseClipboard (method)">#releaseClipboard</a></span>, <span class='object_link'><a href="FXWindow.html#releaseSelection-instance_method" title="Fox::FXWindow#releaseSelection (method)">#releaseSelection</a></span>, <span class='object_link'><a href="FXWindow.html#remHotKey-instance_method" title="Fox::FXWindow#remHotKey (method)">#remHotKey</a></span>, <span class='object_link'><a href="FXWindow.html#removeChild-instance_method" title="Fox::FXWindow#removeChild (method)">#removeChild</a></span>, <span class='object_link'><a href="FXWindow.html#repaint-instance_method" title="Fox::FXWindow#repaint (method)">#repaint</a></span>, <span class='object_link'><a href="FXWindow.html#reparent-instance_method" title="Fox::FXWindow#reparent (method)">#reparent</a></span>, <span class='object_link'><a href="FXWindow.html#resize-instance_method" title="Fox::FXWindow#resize (method)">#resize</a></span>, <span class='object_link'><a href="FXWindow.html#scroll-instance_method" title="Fox::FXWindow#scroll (method)">#scroll</a></span>, <span class='object_link'><a href="FXWindow.html#setCursorPosition-instance_method" title="Fox::FXWindow#setCursorPosition (method)">#setCursorPosition</a></span>, <span class='object_link'><a href="FXWindow.html#setDNDData-instance_method" title="Fox::FXWindow#setDNDData (method)">#setDNDData</a></span>, <span class='object_link'><a href="FXWindow.html#setDefault-instance_method" title="Fox::FXWindow#setDefault (method)">#setDefault</a></span>, <span class='object_link'><a href="FXWindow.html#setDragRectangle-instance_method" title="Fox::FXWindow#setDragRectangle (method)">#setDragRectangle</a></span>, <span class='object_link'><a href="FXWindow.html#setFocus-instance_method" title="Fox::FXWindow#setFocus (method)">#setFocus</a></span>, <span class='object_link'><a href="FXWindow.html#setInitial-instance_method" title="Fox::FXWindow#setInitial (method)">#setInitial</a></span>, <span class='object_link'><a href="FXWindow.html#setShape-instance_method" title="Fox::FXWindow#setShape (method)">#setShape</a></span>, <span class='object_link'><a href="FXWindow.html#shell%3F-instance_method" title="Fox::FXWindow#shell? (method)">#shell?</a></span>, <span class='object_link'><a href="FXWindow.html#show-instance_method" title="Fox::FXWindow#show (method)">#show</a></span>, <span class='object_link'><a href="FXWindow.html#shown%3F-instance_method" title="Fox::FXWindow#shown? (method)">#shown?</a></span>, <span class='object_link'><a href="FXWindow.html#stringType-class_method" title="Fox::FXWindow.stringType (method)">stringType</a></span>, <span class='object_link'><a href="FXWindow.html#textType-class_method" title="Fox::FXWindow.textType (method)">textType</a></span>, <span class='object_link'><a href="FXWindow.html#textTypeName-class_method" title="Fox::FXWindow.textTypeName (method)">textTypeName</a></span>, <span class='object_link'><a href="FXWindow.html#tr-instance_method" title="Fox::FXWindow#tr (method)">#tr</a></span>, <span class='object_link'><a href="FXWindow.html#translateCoordinatesFrom-instance_method" title="Fox::FXWindow#translateCoordinatesFrom (method)">#translateCoordinatesFrom</a></span>, <span class='object_link'><a href="FXWindow.html#translateCoordinatesTo-instance_method" title="Fox::FXWindow#translateCoordinatesTo (method)">#translateCoordinatesTo</a></span>, <span class='object_link'><a href="FXWindow.html#underCursor%3F-instance_method" title="Fox::FXWindow#underCursor? (method)">#underCursor?</a></span>, <span class='object_link'><a href="FXWindow.html#ungrab-instance_method" title="Fox::FXWindow#ungrab (method)">#ungrab</a></span>, <span class='object_link'><a href="FXWindow.html#ungrabKeyboard-instance_method" title="Fox::FXWindow#ungrabKeyboard (method)">#ungrabKeyboard</a></span>, <span class='object_link'><a href="FXWindow.html#update-instance_method" title="Fox::FXWindow#update (method)">#update</a></span>, <span class='object_link'><a href="FXWindow.html#urilistType-class_method" title="Fox::FXWindow.urilistType (method)">urilistType</a></span>, <span class='object_link'><a href="FXWindow.html#urilistTypeName-class_method" title="Fox::FXWindow.urilistTypeName (method)">urilistTypeName</a></span>, <span class='object_link'><a href="FXWindow.html#utf16Type-class_method" title="Fox::FXWindow.utf16Type (method)">utf16Type</a></span>, <span class='object_link'><a href="FXWindow.html#utf16TypeName-class_method" title="Fox::FXWindow.utf16TypeName (method)">utf16TypeName</a></span>, <span class='object_link'><a href="FXWindow.html#utf8Type-class_method" title="Fox::FXWindow.utf8Type (method)">utf8Type</a></span>, <span class='object_link'><a href="FXWindow.html#utf8TypeName-class_method" title="Fox::FXWindow.utf8TypeName (method)">utf8TypeName</a></span>, <span class='object_link'><a href="FXWindow.html#visible=-instance_method" title="Fox::FXWindow#visible= (method)">#visible=</a></span>, <span class='object_link'><a href="FXWindow.html#width-instance_method" title="Fox::FXWindow#width (method)">#width</a></span>, <span class='object_link'><a href="FXWindow.html#width=-instance_method" title="Fox::FXWindow#width= (method)">#width=</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Responder2.html" title="Responder2 (module)">Responder2</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../Responder2.html#connect-instance_method" title="Responder2#connect (method)">#connect</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXDrawable.html" title="Fox::FXDrawable (class)">FXDrawable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXDrawable.html#resize-instance_method" title="Fox::FXDrawable#resize (method)">#resize</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#create-instance_method" title="Fox::FXId#create (method)">#create</a></span>, <span class='object_link'><a href="FXId.html#created%3F-instance_method" title="Fox::FXId#created? (method)">#created?</a></span>, <span class='object_link'><a href="FXId.html#destroy-instance_method" title="Fox::FXId#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="FXId.html#detach-instance_method" title="Fox::FXId#detach (method)">#detach</a></span>, <span class='object_link'><a href="FXId.html#runOnUiThread-instance_method" title="Fox::FXId#runOnUiThread (method)">#runOnUiThread</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXObject.html#bind-instance_method" title="Fox::FXObject#bind (method)">#bind</a></span>, <span class='object_link'><a href="FXObject.html#handle-instance_method" title="Fox::FXObject#handle (method)">#handle</a></span>, <span class='object_link'><a href="FXObject.html#load-instance_method" title="Fox::FXObject#load (method)">#load</a></span>, <span class='object_link'><a href="FXObject.html#save-instance_method" title="Fox::FXObject#save (method)">#save</a></span>, <span class='object_link'><a href="FXObject.html#subclasses-class_method" title="Fox::FXObject.subclasses (method)">subclasses</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(p, opts = LAYOUT_TOP|LAYOUT_LEFT|LAYOUT_FILL_X, x = 0, y = 0, width = 0, height = 0, padLeft = 3, padRight = 3, padTop = 2, padBottom = 2, hSpacing = DEFAULT_SPACING, vSpacing = DEFAULT_SPACING) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXDockBar (class)">FXDockBar</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct a non-floatable dock bar. The dock bar can not be undocked.</p>
<h4 id="label-Parameters-3A">Parameters:</h4>
<dl class="rdoc-list note-list"><dt><code>p</code>
<dd>
<p>the parent window for this dock bar <span class='object_link'><a href="FXComposite.html" title="Fox::FXComposite (class)">Fox::FXComposite</a></span></p>
</dd><dt><code>opts</code>
<dd>
<p>dock bar options [Integer]</p>
</dd><dt><code>x</code>
<dd>
<p>initial x-position [Integer]</p>
</dd><dt><code>y</code>
<dd>
<p>initial y-position [Integer]</p>
</dd><dt><code>width</code>
<dd>
<p>initial width [Integer]</p>
</dd><dt><code>height</code>
<dd>
<p>initial height [Integer]</p>
</dd><dt><code>padLeft</code>
<dd>
<p>internal padding on the left side, in pixels [Integer]</p>
</dd><dt><code>padRight</code>
<dd>
<p>internal padding on the right side, in pixels [Integer]</p>
</dd><dt><code>padTop</code>
<dd>
<p>internal padding on the top side, in pixels [Integer]</p>
</dd><dt><code>padBottom</code>
<dd>
<p>internal padding on the bottom side, in pixels [Integer]</p>
</dd><dt><code>hSpacing</code>
<dd>
<p>horizontal spacing between widgets, in pixels [Integer]</p>
</dd><dt><code>vSpacing</code>
<dd>
<p>vertical spacing between widgets, in pixels [Integer]</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='comma'>,</span> <span class='id identifier rubyid_q'>q</span><span class='comma'>,</span> <span class='id identifier rubyid_opts'>opts</span><span class='op'>=</span><span class='const'>LAYOUT_TOP</span><span class='op'>|</span><span class='const'>LAYOUT_LEFT</span><span class='op'>|</span><span class='const'>LAYOUT_FILL_X</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='op'>=</span><span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_y'>y</span><span class='op'>=</span><span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_width'>width</span><span class='op'>=</span><span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_height'>height</span><span class='op'>=</span><span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_padLeft'>padLeft</span><span class='op'>=</span><span class='int'>3</span><span class='comma'>,</span> <span class='id identifier rubyid_padRight'>padRight</span><span class='op'>=</span><span class='int'>3</span><span class='comma'>,</span> <span class='id identifier rubyid_padTop'>padTop</span><span class='op'>=</span><span class='int'>2</span><span class='comma'>,</span> <span class='id identifier rubyid_padBottom'>padBottom</span><span class='op'>=</span><span class='int'>2</span><span class='comma'>,</span> <span class='id identifier rubyid_hSpacing'>hSpacing</span><span class='op'>=</span><span class='const'>DEFAULT_SPACING</span><span class='comma'>,</span> <span class='id identifier rubyid_vSpacing'>vSpacing</span><span class='op'>=</span><span class='const'>DEFAULT_SPACING</span><span class='rparen'>)</span> <span class='comment'># :yields: theDockBar
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="dockingSide=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="dockingSide-instance_method">
#<strong>dockingSide</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Docking side, one of <code>LAYOUT_SIDE_LEFT</code>, <code>LAYOUT_SIDE_RIGHT</code>, <code>LAYOUT_SIDE_TOP</code> or <code>LAYOUT_SIDE_BOTTOM</code> [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dockingSide'>dockingSide</span>
<span class='ivar'>@dockingSide</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="allowedSide?-instance_method">
#<strong>allowedSide?</strong>(side) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if docking is allowed on the specified side, where <em>side</em> is one of the <code>ALLOW</code> constants listed above.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
103
104
105</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/core.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_allowedSide?'>allowedSide?</span><span class='lparen'>(</span><span class='id identifier rubyid_side'>side</span><span class='rparen'>)</span>
<span class='lparen'>(</span><span class='id identifier rubyid_allowedSides'>allowedSides</span> <span class='op'>&</span> <span class='id identifier rubyid_side'>side</span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='int'>0</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="allowedSides-instance_method">
#<strong>allowedSides</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return set of sides where docking is allowed</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
148</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 148</span>
<span class='kw'>def</span> <span class='id identifier rubyid_allowedSides'>allowedSides</span><span class='lparen'>(</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="allowedSides=-instance_method">
#<strong>allowedSides=</strong>(allowed) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Change set of sides (a combination of <code>ALLOW_TOP</code>, <code>ALLOW_LEFT</code>, etc.), where docking is allowed. The default is to allow docking on all sides.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
143</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 143</span>
<span class='kw'>def</span> <span class='id identifier rubyid_allowedSides='>allowedSides=</span><span class='lparen'>(</span><span class='id identifier rubyid_allowed'>allowed</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="allowSide-instance_method">
#<strong>allowSide</strong>(side) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Allow docking on the specified side, where <em>side</em> is one of the <code>ALLOW</code> constants listed above.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
90
91
92</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/core.rb', line 90</span>
<span class='kw'>def</span> <span class='id identifier rubyid_allowSide'>allowSide</span><span class='lparen'>(</span><span class='id identifier rubyid_side'>side</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_allowedSides'>allowedSides</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_allowedSides'>allowedSides</span> <span class='op'>|</span> <span class='id identifier rubyid_side'>side</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="disallowSide-instance_method">
#<strong>disallowSide</strong>(side) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Disallow docking on the specified side, where <em>side</em> is one of the <code>ALLOW</code> constants listed above.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
96
97
98</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/fox16/core.rb', line 96</span>
<span class='kw'>def</span> <span class='id identifier rubyid_disallowSide'>disallowSide</span><span class='lparen'>(</span><span class='id identifier rubyid_side'>side</span><span class='rparen'>)</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_allowedSides'>allowedSides</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_allowedSides'>allowedSides</span> <span class='op'>&</span> <span class='op'>~</span><span class='id identifier rubyid_side'>side</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="dock-instance_method">
#<strong>dock</strong>(docksite, local_x, local_y, notify) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Dock the bar against the given side, near the given position relative to the toolbar dock’s origin.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
124</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 124</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dock'>dock</span><span class='lparen'>(</span><span class='id identifier rubyid_docksite'>docksite</span><span class='comma'>,</span> <span class='id identifier rubyid_before'>before</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_notify'>notify</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="docked?-instance_method">
#<strong>docked?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if docked</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 84</span>
<span class='kw'>def</span> <span class='id identifier rubyid_docked?'>docked?</span> <span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="dryDock-instance_method">
#<strong>dryDock</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return parent when docked.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
98</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 98</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dryDock'>dryDock</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="dryDock=-instance_method">
#<strong>dryDock=</strong>(dry) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set parent when docked. If it was docked, reparent under the new docking window.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
95</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 95</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dryDock='>dryDock=</span><span class='lparen'>(</span><span class='id identifier rubyid_dry'>dry</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="findDockAtSide-instance_method">
#<strong>findDockAtSide</strong>(side = LAYOUT_SIDE_TOP) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Search for dock against given side of main window.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
112</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 112</span>
<span class='kw'>def</span> <span class='id identifier rubyid_findDockAtSide'>findDockAtSide</span><span class='lparen'>(</span><span class='id identifier rubyid_side'>side</span><span class='op'>=</span><span class='const'>LAYOUT_SIDE_TOP</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="findDockNear-instance_method">
#<strong>findDockNear</strong>(root_x, root_y) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Search for dock close to coordinates (<em>root_x</em>, <em>root_y</em>).</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
117</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 117</span>
<span class='kw'>def</span> <span class='id identifier rubyid_findDockNear'>findDockNear</span><span class='lparen'>(</span><span class='id identifier rubyid_root_x'>root_x</span><span class='comma'>,</span> <span class='id identifier rubyid_root_y'>root_y</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="insideDock?-instance_method">
#<strong>insideDock?</strong>(docksite, barx, bary) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return <code>true</code> if the dock bar would dock or undock if at locaton (<em>barx</em>, <em>bary</em>).</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_insideDock?'>insideDock?</span><span class='lparen'>(</span><span class='id identifier rubyid_docksite'>docksite</span><span class='comma'>,</span> <span class='id identifier rubyid_barx'>barx</span><span class='comma'>,</span> <span class='id identifier rubyid_bary'>bary</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="undock-instance_method">
#<strong>undock</strong>(root_x, root_y, notify = false) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Undock or float the bar. The initial position of the wet dock is a few pixels below and to the right of the original docked position.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
137</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 137</span>
<span class='kw'>def</span> <span class='id identifier rubyid_undock'>undock</span><span class='lparen'>(</span><span class='id identifier rubyid_root_x'>root_x</span><span class='comma'>,</span> <span class='id identifier rubyid_root_y'>root_y</span><span class='comma'>,</span> <span class='id identifier rubyid_notify'>notify</span><span class='op'>=</span><span class='kw'>false</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="wetDock-instance_method">
#<strong>wetDock</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return parent when floating.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 107</span>
<span class='kw'>def</span> <span class='id identifier rubyid_wetDock'>wetDock</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="wetDock=-instance_method">
#<strong>wetDock=</strong>(wet) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Set parent when floating. If it was undocked, then reparent under the new floating window.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
104</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXDockBar.rb', line 104</span>
<span class='kw'>def</span> <span class='id identifier rubyid_wetDock='>wetDock=</span><span class='lparen'>(</span><span class='id identifier rubyid_wet'>wet</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:34 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.2).
</div>
</div>
</body>
</html>