<doc>
  <legacy_id>2371</legacy_id>
  <name>decorations</name>
  <type>property</type>
  <syntax>
    <example>set the decorations of <i>stack</i> to {<i>controlList</i> | <i>WDEF</i> | default | empty}</example>
  </syntax>
  <library></library>
  <objects>
    <stack/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Windows &amp; Dialog Boxes</category>
  </classification>
  <references>
    <keyword tag="title">title Keyword</keyword>
    <message tag="unIconifyStack">unIconifyStack Message</message>
    <message tag="closeStackRequest">closeStackRequest Message</message>
    <property tag="draggable">draggable Property</property>
    <property tag="closeBox">closeBox Property</property>
    <property tag="windowShape">windowShape Property</property>
    <property tag="systemWindow">systemWindow Property</property>
    <property tag="shadow">shadow Property</property>
    <property tag="zoomBox">zoomBox Property</property>
    <property tag="metal">metal Property</property>
    <property tag="longWindowTitles">longWindowTitles Property</property>
    <property tag="fullscreen">fullscreen Property</property>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
    <changed version="2.1"></changed>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies the window controls and appearance of a <glossary tag="stack window">stack window</glossary>.</summary>
  <examples>
    <example>set the decorations of this stack to "title,minimize"</example>
    <example>set the decorations of stack "Splash Screen" to empty</example>
    <example>set the decorations of stack myStack to 127 <code><i>-- a WDEF resource</i></code></example>
  </examples>
  <description>
    <p>Use the <b>decorations</b> <glossary tag="property">property</glossary> to change the appearance of windows.</p><p/><p><b>Value:</b></p><p>The <b>decorations</b> of a <object tag="stack">stack</object> is one of the following:</p><p>        * "default"</p><p>        * empty</p><p>        * one or more of "title", "minimize", "maximize", "close", "menu", "system", "noShadow", and "metal", separated by commas</p><p>        * a WDEF identifier (on Mac OS or OS X systems)</p><p/><p>By default, the <b>decorations</b> <glossary tag="property">property</glossary> of newly created <function tag="stacks">stacks</function> is set to "default".</p><p/><p><b>Comments:</b></p><p>You can specify one or more of the following decorations:</p><p/><p>        * <code>title</code>: Shows the window's title bar</p><p>        * <code>minimize</code>: Shows the minimize (iconify) box in the title bar</p><p>        * <code>maximize</code>: Shows the maximize (zoom) box in the title bar</p><p>        * <code>close</code>: Shows the close box in the title bar</p><p>        * <code>menu</code>: Shows the menu bar in the window (<glossary tag="Unix">Unix</glossary> and <function tag="openStacks">Windows</function> only)</p><p>        * <code>system</code>: Shows the window as a system window (OS X, Unix, and Windows only)</p><p>        * <code>noShadow</code>: Remove the window's drop shadow (OS X only)</p><p>        * <code>metal</code>: Shows the window with a textured appearance (OS X only)</p><p/><p><code/><b>Note:</b><code/> The "metal" and "system" options are not compatible. If you set a <glossary tag="stack">stack's</glossary> <property tag="decorations">decorations</property> to a <keyword tag="string">string</keyword> that includes both, its window becomes a non-<property tag="metal">metal</property> <glossary tag="system window">system window</glossary>.</p><p/><p><code/><img src="202652"/> <b>Cross-platform note:</b><code/> On <glossary tag="Mac OS">Mac OS systems</glossary>, the "system" option has no effect.</p><p/><p>Setting a stack's <b>decorations</b> to empty removes the entire <glossary tag="title bar">title bar</glossary>, along with the window borders.</p><p/><p>Setting a stack's <b>decorations</b> to "default" gives it appropriate decorations for its <property tag="style">style</property>. If the <property tag="style">style</property> is "topLevel", the window includes all the decorations (<glossary tag="title bar">title bar</glossary>, <glossary tag="menu bar">menu bar</glossary> [on <glossary tag="Unix">Unix</glossary> and <glossary tag="Windows">Windows systems</glossary>], <glossary tag="close box">close box</glossary>, <keyword tag="minimize">minimize</keyword> box, <keyword tag="maximize">maximize</keyword> box) by <keyword tag="default">default</keyword>. Otherwise, the window includes a <glossary tag="title bar">title bar</glossary> by <keyword tag="default">default</keyword>.</p><p/><p>The <b>decorations</b> <glossary tag="property">property</glossary> interacts with the <property tag="closeBox">closeBox</property>, <property tag="minimizeBox">minimizeBox</property>, <property tag="metal">metal</property>, <keyword tag="shadow">shadow</keyword>, <property tag="systemWindow">systemWindow</property>, and <property tag="zoomBox">zoomBox</property> <property tag="properties">properties</property>. Setting any of these <property tag="properties">properties</property> to true changes the <b>decorations</b> <glossary tag="property">property</glossary> to include the corresponding option, and including any of the "close", "minimize", "metal", "noShadow", "system", and "maximize" options in a <glossary tag="stack">stack's</glossary> <b>decorations</b> sets the corresponding <glossary tag="property">property</glossary> to true.</p><p/><p><code/><b> Important!</b><code/>  The <b>decorations</b> are set all at once, and if you don't include a decoration, it is removed from the stack window. For example, if you set the decorations to "metal", the resulting window won't include a title bar, even if it had one initially. To set a stack to metal appearance while showing a title bar with close, minimize, and maximize box, you need to set all the decorations at once:</p><p/><p><code>  set the decorations of stack "Test" to \</code></p><p><code>     "metal,title,close,minimize,maximize"</code></p><p/><p>This applies only to the <b>decorations</b> property. If you use the individual properties (such as <b>metal</b> and <b>closeBox</b>) instead, you don't need to reset the other decorations-related properties.</p><p/><p><code/><img src="202652"/> <b>Cross-platform note:</b><code/> On Mac OS and OS X systems, the "menu" decoration has no effect. On Windows systems, the "menu" decoration must be set along with the "maximize" or "minimize" decorations: you cannot use "maximize" or "minimize" without including "menu". On OS X systems, the minimize, close, and zoom boxes are always visible if the title bar is, and turning off these options disables the boxes instead of removing them, in comformance with user-interface guidelines for this platform.</p><p/><p>A WDEF identifier is the number of a Mac OS WDEF resource multiplied by 16, plus a variation code between zero and 15. For example, if you have a WDEF resource whose ID is 124, and you want to use its 14th variation (which is number 13, since the numbers start with zero), set the stack's <b>decorations</b> <glossary tag="property">property</glossary> to 1997. This number is 124 (the resource ID) times 16, plus 13 (the variation code). Various <glossary tag="WDEF">WDEF</glossary> resources are included in the operating system--the exact <glossary tag="WDEF">WDEFs</glossary> available vary from version to version. <glossary tag="WDEF">WDEF</glossary> routines, like <property tag="externals">externals</property>, can be written in a programming language and compiled.</p><p/><p><code/><img src="202652"/> <b>Cross-platform note:</b><code/> <glossary tag="WDEF">WDEF resources</glossary> can be used only on <glossary tag="Mac OS">Mac OS</glossary> and <glossary tag="OS X">OS X systems</glossary>. For a <href tag="../glossary/crossdashplatform.xml">cross-platform</href> method of changing a window's shape, use the <property tag="windowShape">windowShape</property> <glossary tag="property">property</glossary>.</p><p/><p><b>Changes:</b></p><p>The "close", "system", "noShadow", and "metal" options were introduced in version 2.1.</p>
  </description>
</doc>