Sophie

Sophie

distrib > Fedora > 14 > x86_64 > by-pkgid > c67c6057ffd14254a26624517a2352e6 > files > 30

i3-doc-3.e-3.bf1.fc14.noarch.rpm

<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>i3: xoutput Struct 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.2-20100208 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</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>Data&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>xoutput Struct Reference</h1><!-- doxytag: class="xoutput" -->
<p>An Output is a physical output on your graphics driver.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00036_source.html">data.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for xoutput:</div>
<div class="dynsection">
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a0dc25a3a738635b1c470af4841ca1b86">SLIST_HEAD</a> (dock_clients_head, <a class="el" href="a00007.html">Client</a>) dock_clients</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Contains all clients with _NET_WM_WINDOW_TYPE == _NET_WM_WINDOW_TYPE_DOCK.  <a href="#a0dc25a3a738635b1c470af4841ca1b86"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#aa3190dd240d0763851342d4783f514e6">TAILQ_ENTRY</a> (<a class="el" href="a00026.html">xoutput</a>) <a class="el" href="a00048.html#a9fecba0738529e3d9ff0d4fa7c31ffa9">outputs</a></td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xcb_randr_output_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#ac1db5d4876f5f1889f055467cdf603fb">id</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Output id, so that we can requery the output directly later.  <a href="#ac1db5d4876f5f1889f055467cdf603fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a4c8b185b15cf45e3ca300cb54b2d4650">name</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Name of the output.  <a href="#a4c8b185b15cf45e3ca300cb54b2d4650"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a7c56e7415ebe0aa040614d1244e2da6b">active</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Whether the output is currently active (has a CRTC attached with a valid mode).  <a href="#a7c56e7415ebe0aa040614d1244e2da6b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a48ee50473c1b9df6dc1e2439f2c24c44">changed</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal flags, necessary for querying RandR screens (happens in two stages).  <a href="#a48ee50473c1b9df6dc1e2439f2c24c44"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a7b4041fff9af92986ea35fe167760c76">to_be_disabled</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00025.html">Workspace</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a9bcf702b65d8f47f98eafbefff529ffe">current_workspace</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Current workspace selected on this virtual screen.  <a href="#a9bcf702b65d8f47f98eafbefff529ffe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00020.html">Rect</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#aedbb714bf5d5ef9a28b5ff048321ed99">rect</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">x, y, width, height  <a href="#aedbb714bf5d5ef9a28b5ff048321ed99"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xcb_window_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a479cef7d03401926d37ee89a6ee37aed">bar</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The bar window.  <a href="#a479cef7d03401926d37ee89a6ee37aed"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xcb_gcontext_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a1463701491a3a9454f7a3a6efdabf566">bargc</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>An Output is a physical output on your graphics driver. </p>
<p>Outputs which are currently in use have (output-&gt;active == true). Each output has a position and a mode. An output usually corresponds to one connected screen (except if you are running multiple screens in clone mode). </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00512">512</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0dc25a3a738635b1c470af4841ca1b86"></a><!-- doxytag: member="xoutput::SLIST_HEAD" ref="a0dc25a3a738635b1c470af4841ca1b86" args="(dock_clients_head, Client) dock_clients" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xoutput::SLIST_HEAD </td>
          <td>(</td>
          <td class="paramtype">dock_clients_head&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00007.html">Client</a>&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Contains all clients with _NET_WM_WINDOW_TYPE == _NET_WM_WINDOW_TYPE_DOCK. </p>

</div>
</div>
<a class="anchor" id="aa3190dd240d0763851342d4783f514e6"></a><!-- doxytag: member="xoutput::TAILQ_ENTRY" ref="aa3190dd240d0763851342d4783f514e6" args="(xoutput) outputs" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xoutput::TAILQ_ENTRY </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00026.html">xoutput</a>&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a7c56e7415ebe0aa040614d1244e2da6b"></a><!-- doxytag: member="xoutput::active" ref="a7c56e7415ebe0aa040614d1244e2da6b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00026.html#a7c56e7415ebe0aa040614d1244e2da6b">xoutput::active</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Whether the output is currently active (has a CRTC attached with a valid mode). </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00520">520</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00060_source.html#l00156">client_enter_fullscreen()</a>, <a class="el" href="a00073_source.html#l00216">disable_randr()</a>, <a class="el" href="a00073_source.html#l00084">get_first_output()</a>, <a class="el" href="a00073_source.html#l00070">get_output_by_name()</a>, <a class="el" href="a00073_source.html#l00099">get_output_containing()</a>, <a class="el" href="a00073_source.html#l00122">get_output_most()</a>, <a class="el" href="a00075_source.html#l00151">handle_signal()</a>, <a class="el" href="a00073_source.html#l00367">init_workspaces()</a>, <a class="el" href="a00068_source.html#l00241">IPC_HANDLER()</a>, <a class="el" href="a00080_source.html#l00050">query_screens()</a>, and <a class="el" href="a00073_source.html#l00387">randr_query_outputs()</a>.</p>

</div>
</div>
<a class="anchor" id="a479cef7d03401926d37ee89a6ee37aed"></a><!-- doxytag: member="xoutput::bar" ref="a479cef7d03401926d37ee89a6ee37aed" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xcb_window_t <a class="el" href="a00026.html#a479cef7d03401926d37ee89a6ee37aed">xoutput::bar</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The bar window. </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00534">534</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00059_source.html#l00128">button_press_bar()</a>, <a class="el" href="a00067_source.html#l00770">handle_expose_event()</a>, <a class="el" href="a00073_source.html#l00166">initialize_output()</a>, <a class="el" href="a00073_source.html#l00246">output_change_mode()</a>, and <a class="el" href="a00069_source.html#l00596">render_internal_bar()</a>.</p>

</div>
</div>
<a class="anchor" id="a1463701491a3a9454f7a3a6efdabf566"></a><!-- doxytag: member="xoutput::bargc" ref="a1463701491a3a9454f7a3a6efdabf566" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xcb_gcontext_t <a class="el" href="a00026.html#a1463701491a3a9454f7a3a6efdabf566">xoutput::bargc</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00036_source.html#l00535">535</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00073_source.html#l00166">initialize_output()</a>, and <a class="el" href="a00069_source.html#l00596">render_internal_bar()</a>.</p>

</div>
</div>
<a class="anchor" id="a48ee50473c1b9df6dc1e2439f2c24c44"></a><!-- doxytag: member="xoutput::changed" ref="a48ee50473c1b9df6dc1e2439f2c24c44" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00026.html#a48ee50473c1b9df6dc1e2439f2c24c44">xoutput::changed</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Internal flags, necessary for querying RandR screens (happens in two stages). </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00524">524</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00073_source.html#l00387">randr_query_outputs()</a>.</p>

</div>
</div>
<a class="anchor" id="a9bcf702b65d8f47f98eafbefff529ffe"></a><!-- doxytag: member="xoutput::current_workspace" ref="a9bcf702b65d8f47f98eafbefff529ffe" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00025.html">Workspace</a>* <a class="el" href="a00026.html#a9bcf702b65d8f47f98eafbefff529ffe">xoutput::current_workspace</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Current workspace selected on this virtual screen. </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00528">528</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00067_source.html#l00133">check_crossing_screen_boundary()</a>, <a class="el" href="a00060_source.html#l00156">client_enter_fullscreen()</a>, <a class="el" href="a00061_source.html#l00084">focus_thing()</a>, <a class="el" href="a00067_source.html#l00994">handle_hints()</a>, <a class="el" href="a00073_source.html#l00367">init_workspaces()</a>, <a class="el" href="a00073_source.html#l00166">initialize_output()</a>, <a class="el" href="a00068_source.html#l00178">IPC_HANDLER()</a>, <a class="el" href="a00071_source.html#l00193">main()</a>, <a class="el" href="a00073_source.html#l00387">randr_query_outputs()</a>, <a class="el" href="a00069_source.html#l00596">render_internal_bar()</a>, <a class="el" href="a00069_source.html#l00771">render_layout()</a>, <a class="el" href="a00072_source.html#l00151">reparent_window()</a>, <a class="el" href="a00069_source.html#l00206">reposition_client()</a>, <a class="el" href="a00078_source.html#l00223">workspace_assign_to()</a>, <a class="el" href="a00078_source.html#l00105">workspace_is_visible()</a>, and <a class="el" href="a00078_source.html#l00113">workspace_show()</a>.</p>

</div>
</div>
<a class="anchor" id="ac1db5d4876f5f1889f055467cdf603fb"></a><!-- doxytag: member="xoutput::id" ref="ac1db5d4876f5f1889f055467cdf603fb" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">xcb_randr_output_t <a class="el" href="a00026.html#ac1db5d4876f5f1889f055467cdf603fb">xoutput::id</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Output id, so that we can requery the output directly later. </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00514">514</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00073_source.html#l00057">get_output_by_id()</a>.</p>

</div>
</div>
<a class="anchor" id="a4c8b185b15cf45e3ca300cb54b2d4650"></a><!-- doxytag: member="xoutput::name" ref="a4c8b185b15cf45e3ca300cb54b2d4650" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* <a class="el" href="a00026.html#a4c8b185b15cf45e3ca300cb54b2d4650">xoutput::name</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Name of the output. </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00516">516</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00060_source.html#l00156">client_enter_fullscreen()</a>, <a class="el" href="a00073_source.html#l00216">disable_randr()</a>, <a class="el" href="a00073_source.html#l00070">get_output_by_name()</a>, <a class="el" href="a00068_source.html#l00178">IPC_HANDLER()</a>, <a class="el" href="a00080_source.html#l00050">query_screens()</a>, <a class="el" href="a00073_source.html#l00387">randr_query_outputs()</a>, and <a class="el" href="a00072_source.html#l00151">reparent_window()</a>.</p>

</div>
</div>
<a class="anchor" id="aedbb714bf5d5ef9a28b5ff048321ed99"></a><!-- doxytag: member="xoutput::rect" ref="aedbb714bf5d5ef9a28b5ff048321ed99" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00020.html">Rect</a> <a class="el" href="a00026.html#aedbb714bf5d5ef9a28b5ff048321ed99">xoutput::rect</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>x, y, width, height </p>

<p>Definition at line <a class="el" href="a00036_source.html#l00531">531</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00060_source.html#l00156">client_enter_fullscreen()</a>, <a class="el" href="a00073_source.html#l00216">disable_randr()</a>, <a class="el" href="a00074_source.html#l00047">DRAGGING_CB()</a>, <a class="el" href="a00066_source.html#l00488">floating_move()</a>, <a class="el" href="a00061_source.html#l00084">focus_thing()</a>, <a class="el" href="a00073_source.html#l00099">get_output_containing()</a>, <a class="el" href="a00073_source.html#l00122">get_output_most()</a>, <a class="el" href="a00080_source.html#l00036">get_screen_at()</a>, <a class="el" href="a00075_source.html#l00151">handle_signal()</a>, <a class="el" href="a00073_source.html#l00166">initialize_output()</a>, <a class="el" href="a00068_source.html#l00241">IPC_HANDLER()</a>, <a class="el" href="a00073_source.html#l00246">output_change_mode()</a>, <a class="el" href="a00080_source.html#l00050">query_screens()</a>, <a class="el" href="a00073_source.html#l00387">randr_query_outputs()</a>, <a class="el" href="a00074_source.html#l00076">resize_graphical_handler()</a>, <a class="el" href="a00078_source.html#l00223">workspace_assign_to()</a>, and <a class="el" href="a00078_source.html#l00113">workspace_show()</a>.</p>

</div>
</div>
<a class="anchor" id="a7b4041fff9af92986ea35fe167760c76"></a><!-- doxytag: member="xoutput::to_be_disabled" ref="a7b4041fff9af92986ea35fe167760c76" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="a00026.html#a7b4041fff9af92986ea35fe167760c76">xoutput::to_be_disabled</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="a00036_source.html#l00525">525</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>

<p>Referenced by <a class="el" href="a00073_source.html#l00387">randr_query_outputs()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="a00036_source.html">data.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>