Updated/rewritten description of keybindings user defaults

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/gui/trunk@13951 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Nicola Pero 2002-06-22 18:06:47 +00:00
parent 7ad54bc698
commit 573cb75431

View file

@ -7,6 +7,10 @@
<email address="fedor@gnu.org"/>
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
</author>
<author name="Nicola Pero">
<email address="n.pero@mi.flashnet.it"/>
<url url="http://www.gnustep.org/developers/whoiswho.html"/>
</author>
<version>$Revision$</version>
<date>$Date$</date>
</head>
@ -44,44 +48,65 @@
non bold.
</p>
</desc>
<term>GSDefaultKeyBindings</term>
<term>GSAbortKey</term>
<desc>
<p>
A string, <code>DefaultKeyBindings</code> by default. This
string (with <code>.dict</code> appended) is the name of the
files the library reads to load the default keybindings.
The library first tries to read the file with that name from
The key used to abort the insertion of multi-stroke keybinding.
Default is <code>Control-g</code>.
</p>
</desc>
<term>GSQuoteKey</term>
<desc>
<p>
The key used to quote the next keystroke (so that it is not
interpreted as a keybinding, but just inserted into the text as
it is). Default is <code>Control-q</code>.
</p>
</desc>
<term>GSInsertControlKeystrokes</term>
<desc>
<p>
A boolean, by default NO. If you set it to YES, keystrokes
containing a Control are inserted into the text when they can't
be interpreted as keybindings. By default, they are ignored
and cause the computer to beep.
</p>
</desc>
<term>GSKeyBindingsFiles</term>
<desc>
<p>
An array of strings, <code>(DefaultKeyBindings)</code> by
default. The strings in this array (with <code>.dict</code>
appended) are the names of the files the library reads to
load the keybindings. For each of these files (in the order),
the library first tries to read the file with that name from
the
<code>$GNUSTEP_SYSTEM_ROOT/Libraries/Resources/KeyBindings/</code>
directory, loading all the keybindings it finds in the file,
then it loads the similar file from
<code>$GNUSTEP_LOCAL_ROOT</code> and then the similar one
from <code>$GNUSTEP_NETWORK_ROOT</code> and at last the one
from <code>$GNUSTEP_USER_ROOT</code>. If you change the
<code>GSDefaultKeyBindings</code> user default, the library
will not load the default keybindings contained in the
system <code>DefaultKeyBindings.dict</code> file, but
instead load the specified files in its place. You normally
don't want this (so this option is rarely used), because you
normally just want to add your own keybindings to the
default ones, and to do this, you can just add a
<code>DefaultKeyBindings.dict</code> file in your
<code>~/GNUstep/Libraries/Resources/KeyBindings/</code>
from <code>$GNUSTEP_USER_ROOT</code>. If you have a single
set of customized keybindings which you want to be loaded in
addition to the default ones (or overriding some of the default
ones), just add a <code>DefaultKeybindings.dict</code> file
in your <code>~/GNUstep/Libraries/Resources/KeyBindings/</code>
directory, and keybindings from this file are automatically
loaded in addition to the default ones. Setting
<code>GSDefaultKeyBindings</code> will instead cause the
default keybindings not to be read at all.
loaded in addition to the default ones; you do not need to
change this user default. If instead you want more keybinding
files to be loaded, or you do not want the system default keybindings
file to be loaded, you might well need to change it.
</p>
</desc>
<term>GSCustomKeyBindings</term>
<term>GSKeyBindings</term>
<desc>
<p>
An array of strings. If set, the strings are interpreted as
filenames and the keybindings from those files are loaded after
the default ones, in the order they are specified in the array.
Might be useful if you want to have different applications use
different keybindings (you can then run each application with
a different <code>GSCustomKeyBindings</code> default).
A dictionary, containing keybindings which are loaded by the
library after the ones found in the <code>GSKeyBindingsFiles</code>.
Might be useful if you have only a couple of keybindings, and
don't want to write a custom keybindings file. If you have many
keybindings, it is recommended that you keep them in a file.
The syntax of keybindings entries and files is documented elsewhere.
</p>
</desc>
<term>GSSavePanelShowProgress</term>