Source

cappuccino-docs / cappuccino docs / cappuccino.org / learn / documentation / class_c_p_panel.html

Full commit
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<!-- Mirrored from cappuccino.org/learn/documentation/class_c_p_panel.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:17:45 GMT -->
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Cappuccino API: CPPanel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>CPPanel Class Reference<br/>
<small>
[<a class="el" href="group__appkit.html">AppKit</a>]</small>
</h1><!-- doxytag: class="CPPanel" -->
<p><a href="class_c_p_panel-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(BOOL)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_panel.html#a6a73a5ef1356826dca2e8749169256f6">becomesKeyOnlyIfNeeded</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(BOOL)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_panel.html#a7cdd95663938357f332cada9308a9ddd">canBecomeMainWindow</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(BOOL)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_panel.html#a8e6b1b3034fa22ab9daddbf940c0ef76">isFloatingPanel</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_panel.html#a48f29fd997ead765ddd449494b84cd64">setBecomesKeyOnlyIfNeeded:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_panel.html#a720073b07c107e8910035c1579192f08">setFloatingPanel:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_panel.html#aefebec1a1063ce94b8e234541069383f">setWorksWhenModal:</a><code> [implementation]</code></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">(BOOL)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="class_c_p_panel.html#a7dc7f2ab9f4ba2f7b0204513595504a4">worksWhenModal</a><code> [implementation]</code></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The <a class="el" href="class_c_p_panel.html">CPPanel</a> class defines objects that manage the panels of the Cappuccino user interface. A panel is a window that serves an auxiliary function within an application. It generally displays controls that the user can act on to give instructions to the application or to modify the contents of a standard window.</p>
<p>Panels behave differently from standard windows in only a small number of ways, but the ways are important to the user interface:</p>
<ul>
<li>
Panels can assume key window status but not main window status. (The key window receives keyboard events. The main window is the primary focus of user actions; it might contain the document the user is working on, for example.) </li>
</ul>
<p>To aid in their auxiliary role, panels can be assigned special behaviors:</p>
<ul>
<li>
A panel can be precluded from becoming the key window until the user makes a selection (makes some view in the panel the first responder) indicating an intention to begin typing. This prevents key window status from shifting to the panel unnecessarily. </li>
<li>
Palettes and similar panels can be made to float above standard windows and other panels. This prevents them from being covered and keeps them readily available to the user. </li>
<li>
A panel can be made to work even when there's an attention panel on-screen. This permits actions within the panel to affect the attention panel. </li>
</ul>

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00056">56</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6a73a5ef1356826dca2e8749169256f6"></a><!-- doxytag: member="CPPanel::becomesKeyOnlyIfNeeded" ref="a6a73a5ef1356826dca2e8749169256f6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) becomesKeyOnlyIfNeeded </td>
          <td></td>
          <td class="paramname"></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns <code>YES</code> if the window only becomes key if needed. <code>NO</code> means it behaves just like other windows. </p>

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00084">84</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>

</div>
</div>
<a class="anchor" id="a7cdd95663938357f332cada9308a9ddd"></a><!-- doxytag: member="CPPanel::canBecomeMainWindow" ref="a7cdd95663938357f332cada9308a9ddd" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) canBecomeMainWindow </td>
          <td></td>
          <td class="paramname"></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00112">112</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>

</div>
</div>
<a class="anchor" id="a8e6b1b3034fa22ab9daddbf940c0ef76"></a><!-- doxytag: member="CPPanel::isFloatingPanel" ref="a8e6b1b3034fa22ab9daddbf940c0ef76" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) isFloatingPanel </td>
          <td></td>
          <td class="paramname"></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns <code>YES</code> if the receiver is a floating panel (like a palette). </p>

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00065">65</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>

</div>
</div>
<a class="anchor" id="a48f29fd997ead765ddd449494b84cd64"></a><!-- doxytag: member="CPPanel::setBecomesKeyOnlyIfNeeded:" ref="a48f29fd997ead765ddd449494b84cd64" args="(BOOL shouldBecomeKeyOnlyIfNeeded)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) setBecomesKeyOnlyIfNeeded: </td>
          <td></td>
          <td class="paramtype">(BOOL)&nbsp;</td>
          <td class="paramname"> <em>shouldBecomeKeyOnlyIfNeeded</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets whether the the window becomes key only if needed. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>shouldBecomeKeyOnlyIfNeeded</em>&nbsp;</td><td><code>YES</code> makes the window become key only if needed </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00093">93</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>

</div>
</div>
<a class="anchor" id="a720073b07c107e8910035c1579192f08"></a><!-- doxytag: member="CPPanel::setFloatingPanel:" ref="a720073b07c107e8910035c1579192f08" args="(BOOL isFloatingPanel)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) setFloatingPanel: </td>
          <td></td>
          <td class="paramtype">(BOOL)&nbsp;</td>
          <td class="paramname"> <em>isFloatingPanel</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the receiver to be a floating panel. <code>YES</code> makes the window a floating panel. <code>NO</code> makes it a normal window. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>isFloatingPanel</em>&nbsp;</td><td>specifies whether to make it floating </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00075">75</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>

</div>
</div>
<a class="anchor" id="aefebec1a1063ce94b8e234541069383f"></a><!-- doxytag: member="CPPanel::setWorksWhenModal:" ref="aefebec1a1063ce94b8e234541069383f" args="(BOOL shouldWorkWhenModal)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (void) setWorksWhenModal: </td>
          <td></td>
          <td class="paramtype">(BOOL)&nbsp;</td>
          <td class="paramname"> <em>shouldWorkWhenModal</em></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets whether this window can receive input while another window is running modally. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>shouldWorkWhenModal</em>&nbsp;</td><td>whether to receive input while another window is modal </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00107">107</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>

</div>
</div>
<a class="anchor" id="a7dc7f2ab9f4ba2f7b0204513595504a4"></a><!-- doxytag: member="CPPanel::worksWhenModal" ref="a7dc7f2ab9f4ba2f7b0204513595504a4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">- (BOOL) worksWhenModal </td>
          <td></td>
          <td class="paramname"></td>
          <td>&nbsp;</td>
          <td><code> [implementation]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_p_panel_8j_source.html#l00098">98</a> of file <a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>AppKit/<a class="el" href="_c_p_panel_8j_source.html">CPPanel.j</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Tue Apr 6 10:33:06 2010 for Cappuccino API by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>

<!-- Mirrored from cappuccino.org/learn/documentation/class_c_p_panel.html by HTTrack Website Copier/3.x [XR&CO'2006], Mon, 20 Sep 2010 02:17:46 GMT -->
</html>