TDE
/
tqscintilla
mirror of https://mirror.git.trinitydesktop.org/gitea/TDE/tqscintilla
0
0
Fork 0
Code Issues Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
tqscintilla/doc/en/classTQextScintillaCommand....

177 lines
8.6 KiB
Raw Permalink Blame History

<!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: TQextScintillaCommand 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>TQextScintillaCommand Class Reference</h1><!-- doxytag: class="TQextScintillaCommand" -->The <a class="el" href="classTQextScintillaCommand.html">TQextScintillaCommand</a> class represents an internal editor command that may have one or two keys bound to it.
<a href="#_details">More...</a>
<p>
<code>#include &lt;tqextscintillacommand.h&gt;</code>
<p>
<a href="classTQextScintillaCommand-members.html">List of all members.</a><h2>Public Member Functions</h2>
<ul>
<li>void <a class="el" href="classTQextScintillaCommand.html#5d8f8e66928022855f859f2ef62f98ce">setKey</a> (int key)
<li>void <a class="el" href="classTQextScintillaCommand.html#2ceda942ff321060804d2373eecf7ddd">setAlternateKey</a> (int altkey)
<li>int <a class="el" href="classTQextScintillaCommand.html#8adefa65b3b42a0e41fd2e440ccd277d">key</a> () const
<li>int <a class="el" href="classTQextScintillaCommand.html#b42a52b6cc20d45fcce5838fd409f41d">alternateKey</a> () const
<li>TQString <a class="el" href="classTQextScintillaCommand.html#76940cf10cf05d99baf3d9b989109777">description</a> () const
</ul>
<h2>Static Public Member Functions</h2>
<ul>
<li>static bool <a class="el" href="classTQextScintillaCommand.html#d4d553cb5852576f68d55c5952a2c4d9">validKey</a> (int key)
</ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classTQextScintillaCommand.html">TQextScintillaCommand</a> class represents an internal editor command that may have one or two keys bound to it.
<p>
Methods are provided to change the keys bound to the command and to remove a key binding. Each command has a user friendly description of the command for use in key mapping dialogs.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5d8f8e66928022855f859f2ef62f98ce"></a><!-- doxytag: member="TQextScintillaCommand::setKey" ref="5d8f8e66928022855f859f2ef62f98ce" args="(int key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TQextScintillaCommand::setKey </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>key</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Binds the key <em>key</em> to the command. If <em>key</em> is 0 then the key binding is removed. If <em>key</em> is invalid then the key binding is unchanged. Valid keys are any visible or control character or any of <code>Key_Down</code>, <code>Key_Up</code>, <code>Key_Left</code>, <code>Key_Right</code>, <code>Key_Home</code>, <code>Key_End</code>, <code>Key_Prior</code>, <code>Key_Next</code>, <code>Key_Delete</code>, <code>Key_Insert</code>, <code>Key_Escape</code>, <code>Key_Backspace</code>, <code>Key_Tab</code> and <code>Key_Return</code>. Keys may be modified with any combination of <code>SHIFT</code>, <code>CTRL</code> and <code>ALT</code>.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classTQextScintillaCommand.html#8adefa65b3b42a0e41fd2e440ccd277d">key()</a>, <a class="el" href="classTQextScintillaCommand.html#2ceda942ff321060804d2373eecf7ddd">setAlternateKey()</a>, <a class="el" href="classTQextScintillaCommand.html#d4d553cb5852576f68d55c5952a2c4d9">validKey()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="2ceda942ff321060804d2373eecf7ddd"></a><!-- doxytag: member="TQextScintillaCommand::setAlternateKey" ref="2ceda942ff321060804d2373eecf7ddd" args="(int altkey)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TQextScintillaCommand::setAlternateKey </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>altkey</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Binds the alternate key <em>altkey</em> to the command. If <em>key</em> is 0 then the alternate key binding is removed.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classTQextScintillaCommand.html#b42a52b6cc20d45fcce5838fd409f41d">alternateKey()</a>, <a class="el" href="classTQextScintillaCommand.html#5d8f8e66928022855f859f2ef62f98ce">setKey()</a>, <a class="el" href="classTQextScintillaCommand.html#d4d553cb5852576f68d55c5952a2c4d9">validKey()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="8adefa65b3b42a0e41fd2e440ccd277d"></a><!-- doxytag: member="TQextScintillaCommand::key" ref="8adefa65b3b42a0e41fd2e440ccd277d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int TQextScintillaCommand::key </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The key that is currently bound to the command is returned.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classTQextScintillaCommand.html#5d8f8e66928022855f859f2ef62f98ce">setKey()</a>, <a class="el" href="classTQextScintillaCommand.html#b42a52b6cc20d45fcce5838fd409f41d">alternateKey()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="b42a52b6cc20d45fcce5838fd409f41d"></a><!-- doxytag: member="TQextScintillaCommand::alternateKey" ref="b42a52b6cc20d45fcce5838fd409f41d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int TQextScintillaCommand::alternateKey </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The alternate key that is currently bound to the command is returned.<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classTQextScintillaCommand.html#2ceda942ff321060804d2373eecf7ddd">setAlternateKey()</a>, <a class="el" href="classTQextScintillaCommand.html#8adefa65b3b42a0e41fd2e440ccd277d">key()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="d4d553cb5852576f68d55c5952a2c4d9"></a><!-- doxytag: member="TQextScintillaCommand::validKey" ref="d4d553cb5852576f68d55c5952a2c4d9" args="(int key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool TQextScintillaCommand::validKey </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>key</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If the key <em>key</em> is valid then TRUE is returned.
<p>
</div>
</div><p>
<a class="anchor" name="76940cf10cf05d99baf3d9b989109777"></a><!-- doxytag: member="TQextScintillaCommand::description" ref="76940cf10cf05d99baf3d9b989109777" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TQString TQextScintillaCommand::description </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The user friendly description of the command is returned.
<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>
View Git Blame Copy Permalink