tqscintilla/doc/html/classQextScintillaCommandSe...

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>TQScintilla: QextScintillaCommandSet Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li id="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul></div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<h1>QextScintillaCommandSet Class Reference</h1><!-- doxytag: class="QextScintillaCommandSet" -->The <a class="el" href="classQextScintillaCommandSet.html">QextScintillaCommandSet</a> class represents the set of all internal editor commands that may have keys bound.
<a href="#_details">More...</a>
<p>
<code>#include &lt;qextscintillacommandset.h&gt;</code>
<p>
<a href="classQextScintillaCommandSet-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li>bool <a class="el" href="classQextScintillaCommandSet.html#a6e09aabf6126617ecec01c35fb32e53">readSettings</a> (TQSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)
<li>bool <a class="el" href="classQextScintillaCommandSet.html#3a4981c26ab30164efbf27d15a4828ee">writeSettings</a> (TQSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)
<li>TQPtrList&lt; <a class="el" href="classQextScintillaCommand.html">QextScintillaCommand</a> &gt; &amp; <a class="el" href="classQextScintillaCommandSet.html#3d5be67e3bbd4cf614c4baa6f8aacc37">commands</a> ()
<li>void <a class="el" href="classQextScintillaCommandSet.html#473747a515d9b554748aa4c25b371cc2">clearKeys</a> ()
<li>void <a class="el" href="classQextScintillaCommandSet.html#497658e87e32bb8d6e9f3859a70e1107">clearAlternateKeys</a> ()
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classQextScintillaCommandSet.html">QextScintillaCommandSet</a> class represents the set of all internal editor commands that may have keys bound.
<p>
Methods are provided to access the individual commands and to read and write the current bindings from and to settings files.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a6e09aabf6126617ecec01c35fb32e53"></a><!-- doxytag: member="QextScintillaCommandSet::readSettings" ref="a6e09aabf6126617ecec01c35fb32e53" args="(TQSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QextScintillaCommandSet::readSettings           </td>
          <td>(</td>
          <td class="paramtype">TQSettings &amp;&nbsp;</td>
          <td class="paramname"> <em>qs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>prefix</em> = <code>&quot;/Scintilla&quot;</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The key bindings for each command in the set are read from the settings <em>qs</em>. <em>prefix</em> is prepended to the key of each entry. TRUE is returned if there was no error.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommandSet.html#3a4981c26ab30164efbf27d15a4828ee">writeSettings()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="3a4981c26ab30164efbf27d15a4828ee"></a><!-- doxytag: member="QextScintillaCommandSet::writeSettings" ref="3a4981c26ab30164efbf27d15a4828ee" args="(TQSettings &amp;qs, const char *prefix=&quot;/Scintilla&quot;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool QextScintillaCommandSet::writeSettings           </td>
          <td>(</td>
          <td class="paramtype">TQSettings &amp;&nbsp;</td>
          <td class="paramname"> <em>qs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>prefix</em> = <code>&quot;/Scintilla&quot;</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The key bindings for each command in the set are written to the settings <em>qs</em>. <em>prefix</em> is prepended to the key of each entry. TRUE is returned if there was no error.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaCommandSet.html#a6e09aabf6126617ecec01c35fb32e53">readSettings()</a> </dd></dl>

</div>
</div><p>
<a class="anchor" name="3d5be67e3bbd4cf614c4baa6f8aacc37"></a><!-- doxytag: member="QextScintillaCommandSet::commands" ref="3d5be67e3bbd4cf614c4baa6f8aacc37" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">TQPtrList&lt;<a class="el" href="classQextScintillaCommand.html">QextScintillaCommand</a>&gt;&amp; QextScintillaCommandSet::commands           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The commands in the set are returned as a list.
<p>

</div>
</div><p>
<a class="anchor" name="473747a515d9b554748aa4c25b371cc2"></a><!-- doxytag: member="QextScintillaCommandSet::clearKeys" ref="473747a515d9b554748aa4c25b371cc2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QextScintillaCommandSet::clearKeys           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The primary keys bindings for all commands are removed.
<p>

</div>
</div><p>
<a class="anchor" name="497658e87e32bb8d6e9f3859a70e1107"></a><!-- doxytag: member="QextScintillaCommandSet::clearAlternateKeys" ref="497658e87e32bb8d6e9f3859a70e1107" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void QextScintillaCommandSet::clearAlternateKeys           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The alternate keys bindings for all commands are removed.
<p>

</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for TQScintilla by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>