annotate man/lispref/x-windows.texi @ 2367:ecf1ebac70d8

[xemacs-hg @ 2004-11-04 23:05:23 by ben] commit mega-patch configure.in: Turn off -Winline and -Wchar-subscripts. Use the right set of cflags when compiling modules. Rewrite ldap configuration to separate the inclusion of lber (needed in recent Cygwin) from the basic checks for the needed libraries. add a function for MAKE_JUNK_C; initially code was added to generate xemacs.def using this, but it will need to be rewritten. add an rm -f for junk.c to avoid weird Cygwin bug with cp -f onto an existing file. Sort list of auto-detected functions and eliminate unused checks for stpcpy, setlocale and getwd. Add autodetection of Cygwin scanf problems BETA: Rewrite section on configure to indicate what flags are important and what not. digest-doc.c, make-dump-id.c, profile.c, sorted-doc.c: Add proper decls for main(). make-msgfile.c: Document that this is old junk. Move proposal to text.c. make-msgfile.lex: Move proposal to text.c. make-mswin-unicode.pl: Convert error-generating code so that the entire message will be seen as a single unrecognized token. mule/mule-ccl.el: Update docs. lispref/mule.texi: Update CCL docs. ldap/eldap.c: Mule-ize. Use EXTERNAL_LIST_LOOP_2 instead of deleted EXTERNAL_LIST_LOOP. * XEmacs 21.5.18 "chestnut" is released. --------------------------------------------------------------- MULE-RELATED WORK: --------------------------------------------------------------- --------------------------- byte-char conversion --------------------------- buffer.c, buffer.h, insdel.c, text.c: Port FSF algorithm for byte-char conversion, replacing broken previous version. Track the char position of the gap. Add functions to do char-byte conversion downwards as well as upwards. Move comments about algorithm workings to internals manual. --------------------------- work on types --------------------------- alloc.c, console-x-impl.h, dump-data.c, dump-data.h, dumper.c, dialog-msw.c, dired-msw.c, doc.c, editfns.c, esd.c, event-gtk.h, event-msw.c, events.c, file-coding.c, file-coding.h, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-shared.c, glyphs-x.c, glyphs.c, glyphs.h, gui.c, hpplay.c, imgproc.c, intl-win32.c, lrecord.h, lstream.c, keymap.c, lisp.h, libsst.c, linuxplay.c, miscplay.c, miscplay.h, mule-coding.c, nas.c, nt.c, ntheap.c, ntplay.c, objects-msw.c, objects-tty.c, objects-x.c, print.c, process-nt.c, process.c, redisplay.h, select-common.h, select-gtk.c, select-x.c, sgiplay.c, sound.c, sound.h, sunplay.c, sysfile.h, sysdep.c, syswindows.h, text.c, unexnt.c, win32.c, xgccache.c: Further work on types. This creates a full set of types for all the basic semantics of `char' that I have so far identified, so that its semantics can always be identified for the purposes of proper Mule-safe code, and the raw use of `char' always avoided. (1) More type renaming, for consistency of naming. Char_ASCII -> Ascbyte UChar_ASCII -> UAscbyte Char_Binary -> CBinbyte UChar_Binary -> Binbyte SChar_Binary -> SBinbyte (2) Introduce Rawbyte, CRawbyte, Boolbyte, Chbyte, UChbyte, and Bitbyte and use them. (3) New types Itext, Wexttext and Textcount for separating out the concepts of bytes and textual units (different under UTF-16 and UTF-32, which are potential internal encodings). (4) qxestr*_c -> qxestr*_ascii. lisp.h: New; goes with other qxe() functions. #### Maybe goes in a different section. lisp.h: Group generic int-type defs together with EMACS_INT defs. lisp.h: * lisp.h (WEXTTEXT_IS_WIDE) New defns. lisp.h: New type to replace places where int occurs as a boolean. It's signed because occasionally people may want to use -1 as an error value, and because unsigned ints are viral -- see comments in the internals manual against using them. dynarr.c: int -> Bytecount. --------------------------- Mule-izing --------------------------- device-x.c: Partially Mule-ize. dumper.c, dumper.h: Mule-ize. Use Rawbyte. Use stderr_out not printf. Use wext_*(). sysdep.c, syswindows.h, text.c: New Wexttext API for manipulation of external text that may be Unicode (e.g. startup code under Windows). emacs.c: Mule-ize. Properly deal with argv in external encoding. Use wext_*() and Wexttext. Use Rawbyte. #if 0 some old junk on SCO that is unlikely to be correct. Rewrite allocation code in run-temacs. emacs.c, symsinit.h, win32.c: Rename win32 init function and call it even earlier, to initialize mswindows_9x_p even earlier, for use in startup code (XEUNICODE_P). process.c: Use _wenviron not environ under Windows, to get Unicode environment variables. event-Xt.c: Mule-ize drag-n-drop related stuff. dragdrop.c, dragdrop.h, frame-x.c: Mule-ize. text.h: Add some more stand-in defines for particular kinds of conversion; use in Mule-ization work in frame-x.c etc. --------------------------- Freshening --------------------------- intl-auto-encap-win32.c, intl-auto-encap-win32.h: Regenerate. --------------------------- Unicode-work --------------------------- intl-win32.c, syswindows.h: Factor out common options to MultiByteToWideChar and WideCharToMultiByte. Add convert_unicode_to_multibyte_malloc() and convert_unicode_to_multibyte_dynarr() and use. Add stuff for alloca() conversion of multibyte/unicode. alloc.c: Use dfc_external_data_len() in case of unicode coding system. alloc.c, mule-charset.c: Don't zero out and reinit charset Unicode tables. This fucks up dump-time loading. Anyway, either we load them at dump time or run time, never both. unicode.c: Dump the blank tables as well. --------------------------------------------------------------- DOCUMENTATION, MOSTLY MULE-RELATED: --------------------------------------------------------------- EmacsFrame.c, emodules.c, event-Xt.c, fileio.c, input-method-xlib.c, mule-wnnfns.c, redisplay-gtk.c, redisplay-tty.c, redisplay-x.c, regex.c, sysdep.c: Add comment about Mule work needed. text.h: Add more documentation describing why DFC routines were not written to return their value. Add some other DFC documentation. console-msw.c, console-msw.h: Add pointer to docs in win32.c. emacs.c: Add comments on sources of doc info. text.c, charset.h, unicode.c, intl-win32.c, intl-encap-win32.c, text.h, file-coding.c, mule-coding.c: Collect background comments and related to text matters and internationalization, and proposals for work to be done, in text.c or Internals manual, stuff related to specific textual API's in text.h, and stuff related to internal implementation of Unicode conversion in unicode.c. Put lots of pointers to the comments to make them easier to find. s/mingw32.h, s/win32-common.h, s/win32-native.h, s/windowsnt.h, win32.c: Add bunches of new documentation on the different kinds of builds and environments under Windows and how they work. Collect this info in win32.c. Add pointers to these docs in the relevant s/* files. emacs.c: Document places with long comments. Remove comment about exiting, move to internals manual, put in pointer. event-stream.c: Move docs about event queues and focus to internals manual, put in pointer. events.h: Move docs about event stream callbacks to internals manual, put in pointer. profile.c, redisplay.c, signal.c: Move documentation to the Internals manual. process-nt.c: Add pointer to comment in win32-native.el. lisp.h: Add comments about some comment conventions. lisp.h: Add comment about the second argument. device-msw.c, redisplay-msw.c: @@#### comments are out-of-date. --------------------------------------------------------------- PDUMP WORK (MOTIVATED BY UNICODE CHANGES) --------------------------------------------------------------- alloc.c, buffer.c, bytecode.c, console-impl.h, console.c, device.c, dumper.c, lrecord.h, elhash.c, emodules.h, events.c, extents.c, frame.c, glyphs.c, glyphs.h, mule-charset.c, mule-coding.c, objects.c, profile.c, rangetab.c, redisplay.c, specifier.c, specifier.h, window.c, lstream.c, file-coding.h, file-coding.c: PDUMP: Properly implement dump_add_root_block(), which never worked before, and is necessary for dumping Unicode tables. Pdump name changes for accuracy: XD_STRUCT_PTR -> XD_BLOCK_PTR. XD_STRUCT_ARRAY -> XD_BLOCK_ARRAY. XD_C_STRING -> XD_ASCII_STRING. *_structure_* -> *_block_*. lrecord.h: some comments added about dump_add_root_block() vs dump_add_root_block_ptr(). extents.c: remove incorrect comment about pdump problems with gap array. --------------------------------------------------------------- ALLOCATION --------------------------------------------------------------- abbrev.c, alloc.c, bytecode.c, casefiddle.c, device-msw.c, device-x.c, dired-msw.c, doc.c, doprnt.c, dragdrop.c, editfns.c, emodules.c, file-coding.c, fileio.c, filelock.c, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-x.c, gui-msw.c, gui-x.c, imgproc.c, intl-win32.c, lread.c, menubar-gtk.c, menubar.c, nt.c, objects-msw.c, objects-x.c, print.c, process-nt.c, process-unix.c, process.c, realpath.c, redisplay.c, search.c, select-common.c, symbols.c, sysdep.c, syswindows.h, text.c, text.h, ui-byhand.c: New macros {alloca,xnew}_{itext,{i,ext,raw,bin,asc}bytes} for more convenient allocation of these commonly requested items. Modify functions to use alloca_ibytes, alloca_array, alloca_extbytes, xnew_ibytes, etc. also XREALLOC_ARRAY, xnew. alloc.c: Rewrite the allocation functions to factor out repeated code. Add assertions for freeing dumped data. lisp.h: Moved down and consolidated with other allocation stuff. lisp.h, dynarr.c: New functions for allocation that's very efficient when mostly in LIFO order. lisp.h, text.c, text.h: Factor out some stuff for general use by alloca()-conversion funs. text.h, lisp.h: Fill out convenience routines for allocating various kinds of bytes and put them in lisp.h. Use them in place of xmalloc(), ALLOCA(). text.h: Fill out the convenience functions so the _MALLOC() kinds match the alloca() kinds. --------------------------------------------------------------- ERROR-CHECKING --------------------------------------------------------------- text.h: Create ASSERT_ASCTEXT_ASCII() and ASSERT_ASCTEXT_ASCII_LEN() from similar Eistring checkers and change the Eistring checkers to use them instead. --------------------------------------------------------------- MACROS IN LISP.H --------------------------------------------------------------- lisp.h: Redo GCPRO declarations. Create a "base" set of functions that can be used to generate any kind of gcpro sets -- regular, ngcpro, nngcpro, private ones used in GC_EXTERNAL_LIST_LOOP_2. buffer.c, callint.c, chartab.c, console-msw.c, device-x.c, dialog-msw.c, dired.c, extents.c, ui-gtk.c, rangetab.c, nt.c, mule-coding.c, minibuf.c, menubar-msw.c, menubar.c, menubar-gtk.c, lread.c, lisp.h, gutter.c, glyphs.c, glyphs-widget.c, fns.c, fileio.c, file-coding.c, specifier.c: Eliminate EXTERNAL_LIST_LOOP, which does not check for circularities. Use EXTERNAL_LIST_LOOP_2 instead or EXTERNAL_LIST_LOOP_3 or EXTERNAL_PROPERTY_LIST_LOOP_3 or GC_EXTERNAL_LIST_LOOP_2 (new macro). Removed/redid comments on EXTERNAL_LIST_LOOP. --------------------------------------------------------------- SPACING FIXES --------------------------------------------------------------- callint.c, hftctl.c, number-gmp.c, process-unix.c: Spacing fixes. --------------------------------------------------------------- FIX FOR GEOMETRY PROBLEM IN FIRST FRAME --------------------------------------------------------------- unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by release 1.5.12 of Cygwin]. toolbar.c: bug fix for problem of initial frame being 77 chars wide on Windows. will be overridden by my other ws. --------------------------------------------------------------- FIX FOR LEAKING PROCESS HANDLES: --------------------------------------------------------------- process-nt.c: Fixes for leaking handles. Inspired by work done by Adrian Aichner <adrian@xemacs.org>. --------------------------------------------------------------- FIX FOR CYGWIN BUG (Unicode-related): --------------------------------------------------------------- unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by release 1.5.12 of Cygwin]. --------------------------------------------------------------- WARNING FIXES: --------------------------------------------------------------- console-stream.c: `reinit' is unused. compiler.h, event-msw.c, frame-msw.c, intl-encap-win32.c, text.h: Add stuff to deal with ANSI-aliasing warnings I got. regex.c: Gather includes together to avoid warning. --------------------------------------------------------------- CHANGES TO INITIALIZATION ROUTINES: --------------------------------------------------------------- buffer.c, emacs.c, console.c, debug.c, device-x.c, device.c, dragdrop.c, emodules.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, event-tty.c, events.c, extents.c, faces.c, file-coding.c, fileio.c, font-lock.c, frame-msw.c, glyphs-widget.c, glyphs.c, gui-x.c, insdel.c, lread.c, lstream.c, menubar-gtk.c, menubar-x.c, minibuf.c, mule-wnnfns.c, objects-msw.c, objects.c, print.c, scrollbar-x.c, search.c, select-x.c, text.c, undo.c, unicode.c, window.c, symsinit.h: Call reinit_*() functions directly from emacs.c, for clarity. Factor out some redundant init code. Move disallowed stuff that had crept into vars_of_glyphs() into complex_vars_of_glyphs(). Call init_eval_semi_early() from eval.c not in the middle of vars_of_() in emacs.c since there should be no order dependency in the latter calls. --------------------------------------------------------------- ARMAGEDDON: --------------------------------------------------------------- alloc.c, emacs.c, lisp.h, print.c: Rename inhibit_non_essential_printing_operations to inhibit_non_essential_conversion_operations. text.c: Assert on !inhibit_non_essential_conversion_operations. console-msw.c, print.c: Don't do conversion in SetConsoleTitle or FindWindow to avoid problems during armageddon. Put #errors for NON_ASCII_INTERNAL_FORMAT in places where problems would arise. --------------------------------------------------------------- CHANGES TO THE BUILD PROCEDURE: --------------------------------------------------------------- config.h.in, s/cxux.h, s/usg5-4-2.h, m/powerpc.h: Add comment about correct ordering of this file. Rearrange everything to follow this -- put all #undefs together and before the s&m files. Add undefs for HAVE_ALLOCA, C_ALLOCA, BROKEN_ALLOCA_IN_FUNCTION_CALLS, STACK_DIRECTION. Remove unused HAVE_STPCPY, HAVE_GETWD, HAVE_SETLOCALE. m/gec63.h: Deleted; totally broken, not used at all, not in FSF. m/7300.h, m/acorn.h, m/alliant-2800.h, m/alliant.h, m/altos.h, m/amdahl.h, m/apollo.h, m/att3b.h, m/aviion.h, m/celerity.h, m/clipper.h, m/cnvrgnt.h, m/convex.h, m/cydra5.h, m/delta.h, m/delta88k.h, m/dpx2.h, m/elxsi.h, m/ews4800r.h, m/gould.h, m/hp300bsd.h, m/hp800.h, m/hp9000s300.h, m/i860.h, m/ibmps2-aix.h, m/ibmrs6000.h, m/ibmrt-aix.h, m/ibmrt.h, m/intel386.h, m/iris4d.h, m/iris5d.h, m/iris6d.h, m/irist.h, m/isi-ov.h, m/luna88k.h, m/m68k.h, m/masscomp.h, m/mg1.h, m/mips-nec.h, m/mips-siemens.h, m/mips.h, m/news.h, m/nh3000.h, m/nh4000.h, m/ns32000.h, m/orion105.h, m/pfa50.h, m/plexus.h, m/pmax.h, m/powerpc.h, m/pyrmips.h, m/sequent-ptx.h, m/sequent.h, m/sgi-challenge.h, m/symmetry.h, m/tad68k.h, m/tahoe.h, m/targon31.h, m/tekxd88.h, m/template.h, m/tower32.h, m/tower32v3.h, m/ustation.h, m/vax.h, m/wicat.h, m/xps100.h: Delete C_ALLOCA, HAVE_ALLOCA, STACK_DIRECTION, BROKEN_ALLOCA_IN_FUNCTION_CALLS. All of this is auto-detected. When in doubt, I followed recent FSF sources, which also have these things deleted.
author ben
date Thu, 04 Nov 2004 23:08:28 +0000
parents 33f0f28b945c
children 9fae6227ede5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 @c -*-texinfo-*-
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2 @c This is part of the XEmacs Lisp Reference Manual.
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 @c See the file lispref.texi for copying conditions.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 @setfilename ../../info/x-windows.texinfo
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6 @node X-Windows, ToolTalk Support, System Interface, Top
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 @chapter Functions Specific to the X Window System
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 @cindex X
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 @cindex X-Windows
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 @c This section is largely different from the one in FSF Emacs.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 XEmacs provides the concept of @dfn{devices}, which generalizes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 connections to an X server, a TTY device, etc. Most information about
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 an X server that XEmacs is connected to can be determined through
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 general console and device functions. @xref{Consoles and Devices}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 However, there are some features of the X Window System that do not
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 generalize well, and they are covered specially here.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 @menu
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
21 * X Selections:: Transferring text to and from other X clients.
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
22 * X Server:: Information about the X server connected to
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
23 a particular device.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 * X Miscellaneous:: Other X-specific functions and variables.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 @end menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 @node X Selections
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 @section X Selections
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29 @cindex selection (for X windows)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31 The X server records a set of @dfn{selections} which permit transfer of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 data between application programs. The various selections are
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33 distinguished by @dfn{selection types}, represented in XEmacs by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 symbols. X clients including XEmacs can read or set the selection for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 any given type.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 @defun x-own-selection data &optional type
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38 This function sets a ``selection'' in the X server. It takes two
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 arguments: a value, @var{data}, and the selection type @var{type} to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 assign it to. @var{data} may be a string, a cons of two markers, or an
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 extent. In the latter cases, the selection is considered to be the text
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 between the markers, or between the extent's endpoints.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 Each possible @var{type} has its own selection value, which changes
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 independently. The usual values of @var{type} are @code{PRIMARY} and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46 @code{SECONDARY}; these are symbols with upper-case names, in accord
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 with X Windows conventions. The default is @code{PRIMARY}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49 (In FSF Emacs, this function is called @code{x-set-selection} and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 takes different arguments.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 @defun x-get-selection
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 This function accesses selections set up by XEmacs or by other X
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 clients. It returns the value of the current primary selection.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 @defun x-disown-selection &optional secondary-p
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 Assuming we own the selection, this function disowns it. If
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60 @var{secondary-p} is non-@code{nil}, the secondary selection instead of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 the primary selection is discarded.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 @cindex cut buffer
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65 The X server also has a set of numbered @dfn{cut buffers} which can
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 store text or other data being moved between applications. Cut buffers
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 are considered obsolete, but XEmacs supports them for the sake of X
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68 clients that still use them.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 @defun x-get-cutbuffer &optional n
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 This function returns the contents of cut buffer number @var{n}. (This
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72 function is called @code{x-get-cut-buffer} in FSF Emacs.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
75 @defun x-store-cutbuffer string &optional push
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76 This function stores @var{string} into the first cut buffer (cut buffer
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
77 0).
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
78
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
79 Normally, the contents of the first cut buffer are simply replaced by
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
80 @var{string}. However, if optional argument @var{push} is
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
81 non-@code{nil}, the cut buffers are rotated. This means that the
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
82 previous value of the first cut buffer moves to the second cut buffer,
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
83 and the second to the third, and so on, moving the other values down
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
84 through the series of cut buffers, kill-ring-style. There are 8 cut
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
85 buffers altogether.
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
86
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
87 Cut buffers are considered obsolete; you should use selections instead.
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
88
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
89 This function has no effect if support for cut buffers was not compiled in.
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
90
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
91 This function is called @code{x-set-cut-buffer} in FSF Emacs.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 @node X Server
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 @section X Server
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 This section describes how to access and change the overall status of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 the X server XEmacs is using.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 @menu
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
101 * Resources:: Getting resource values from the server.
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
102 * Server Data:: Getting info about the X server.
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
103 * Grabs:: Restricting access to the server by other apps.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104 @end menu
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 @node Resources
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 @subsection Resources
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 @defun default-x-device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 This function return the default X device for resourcing. This is the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 first-created X device that still exists.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 @defun x-get-resource name class type &optional locale device noerror
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 This function retrieves a resource value from the X resource manager.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 @itemize @bullet
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119 The first arg is the name of the resource to retrieve, such as
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120 @samp{"font"}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 The second arg is the class of the resource to retrieve, like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 @samp{"Font"}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127 The third arg should be one of the symbols @code{string},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 @code{integer}, @code{natnum}, or @code{boolean}, specifying the type of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129 object that the database is searched for.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 The fourth arg is the locale to search for the resources on, and can
625
33f0f28b945c [xemacs-hg @ 2001-07-02 20:45:03 by adrian]
adrian
parents: 444
diff changeset
133 currently be a buffer, a frame, a device, or the symbol @code{global}.
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134 If omitted, it defaults to @code{global}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137 The fifth arg is the device to search for the resources on. (The
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 resource database for a particular device is constructed by combining
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 non-device- specific resources such any command-line resources specified
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 and any app-defaults files found [or the fallback resources supplied by
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 XEmacs, if no app-defaults file is found] with device-specific resources
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142 such as those supplied using @samp{xrdb}.) If omitted, it defaults to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143 the device of @var{locale}, if a device can be derived (i.e. if
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 @var{locale} is a frame or device), and otherwise defaults to the value
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 of @code{default-x-device}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148 The sixth arg @var{noerror}, if non-@code{nil}, means do not signal an
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 error if a bogus resource specification was retrieved (e.g. if a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 non-integer was given when an integer was requested). In this case, a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 warning is issued instead.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152 @end itemize
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154 The resource names passed to this function are looked up relative to the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155 locale.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 If you want to search for a subresource, you just need to specify the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158 resource levels in @var{name} and @var{class}. For example, @var{name}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159 could be @samp{"modeline.attributeFont"}, and @var{class}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 @samp{"Face.AttributeFont"}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 Specifically,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164 @enumerate
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
165 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
166 If @var{locale} is a buffer, a call
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
167
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
168 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
169 @code{(x-get-resource "foreground" "Foreground" 'string @var{some-buffer})}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
170 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
171
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
172 is an interface to a C call something like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
173
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
174 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
175 @code{XrmGetResource (db, "xemacs.buffer.@var{buffer-name}.foreground",
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
176 "Emacs.EmacsLocaleType.EmacsBuffer.Foreground",
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
177 "String");}
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
178 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
179
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
180 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
181 If @var{locale} is a frame, a call
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
182
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
183 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
184 @code{(x-get-resource "foreground" "Foreground" 'string @var{some-frame})}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
185 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
186
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
187 is an interface to a C call something like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
188 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
189
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
190 @code{XrmGetResource (db, "xemacs.frame.@var{frame-name}.foreground",
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
191 "Emacs.EmacsLocaleType.EmacsFrame.Foreground",
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
192 "String");}
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
193 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
194
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
195 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
196 If @var{locale} is a device, a call
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
197
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
198 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
199 @code{(x-get-resource "foreground" "Foreground" 'string @var{some-device})}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
200 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
201
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
202 is an interface to a C call something like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
203
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
204 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
205 @code{XrmGetResource (db, "xemacs.device.@var{device-name}.foreground",
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
206 "Emacs.EmacsLocaleType.EmacsDevice.Foreground",
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
207 "String");}
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
208 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
209
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
210 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
211 If @var{locale} is the symbol @code{global}, a call
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
212
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
213 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
214 @code{(x-get-resource "foreground" "Foreground" 'string 'global)}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
215 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
216
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
217 is an interface to a C call something like
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
218
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
219 @example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
220 @code{XrmGetResource (db, "xemacs.foreground",
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
221 "Emacs.Foreground",
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
222 "String");}
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
223 @end example
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
224 @end enumerate
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
225
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
226 Note that for @code{global}, no prefix is added other than that of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
227 application itself; thus, you can use this locale to retrieve arbitrary
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
228 application resources, if you really want to.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
229
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
230 The returned value of this function is @code{nil} if the queried
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
231 resource is not found. If @var{type} is @code{string}, a string is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
232 returned, and if it is @code{integer}, an integer is returned. If
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
233 @var{type} is @code{boolean}, then the returned value is the list
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
234 @code{(t)} for true, @code{(nil)} for false, and is @code{nil} to mean
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
235 ``unspecified''.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
236 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
237
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
238 @defun x-put-resource resource-line &optional device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
239 This function adds a resource to the resource database for @var{device}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
240 @var{resource-line} specifies the resource to add and should be a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
241 standard resource specification.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
242 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
243
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
244 @defvar x-emacs-application-class
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
245 This variable holds The X application class of the XEmacs process. This
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
246 controls, among other things, the name of the ``app-defaults'' file that
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
247 XEmacs will use. For changes to this variable to take effect, they must
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
248 be made before the connection to the X server is initialized, that is,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
249 this variable may only be changed before XEmacs is dumped, or by setting
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
250 it in the file @file{lisp/term/x-win.el}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
251
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
252 By default, this variable is @code{nil} at startup. When the connection
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
253 to the X server is first initialized, the X resource database will
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
254 be consulted and the value will be set according to whether any
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
255 resources are found for the application class ``XEmacs''.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
256 @end defvar
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
257
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
258 @node Server Data
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
259 @subsection Data about the X Server
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
260
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
261 This section describes functions and a variable that you can use to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
262 get information about the capabilities and origin of the X server
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
263 corresponding to a particular device. The device argument is generally
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
264 optional and defaults to the selected device.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
265
444
576fb035e263 Import from CVS: tag r21-2-37
cvs
parents: 440
diff changeset
266 @defun x-server-version &optional device
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
267 This function returns the list of version numbers of the X server
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
268 @var{device} is on. The returned value is a list of three integers: the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
269 major and minor version numbers of the X protocol in use, and the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
270 vendor-specific release number.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
271 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
272
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
273 @defun x-server-vendor &optional device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
274 This function returns the vendor supporting the X server @var{device} is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
275 on.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
276 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
277
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
278 @defun x-display-visual-class &optional device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
279 This function returns the visual class of the display @var{device} is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
280 on. The value is one of the symbols @code{static-gray},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
281 @code{gray-scale}, @code{static-color}, @code{pseudo-color},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
282 @code{true-color}, and @code{direct-color}. (Note that this is different
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
283 from previous versions of XEmacs, which returned @code{StaticGray},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
284 @code{GrayScale}, etc.)
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
285 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
286
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
287 @node Grabs
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
288 @subsection Restricting Access to the Server by Other Apps
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
289
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
290 @defun x-grab-keyboard &optional device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
291 This function grabs the keyboard on the given device (defaulting to the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
292 selected one). So long as the keyboard is grabbed, all keyboard events
440
8de8e3f6228a Import from CVS: tag r21-2-28
cvs
parents: 428
diff changeset
293 will be delivered to XEmacs---it is not possible for other X clients to
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
294 eavesdrop on them. Ungrab the keyboard with @code{x-ungrab-keyboard}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
295 (use an @code{unwind-protect}). Returns @code{t} if the grab was
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
296 successful; @code{nil} otherwise.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
297 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
298
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
299 @defun x-ungrab-keyboard &optional device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
300 This function releases a keyboard grab made with @code{x-grab-keyboard}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
301 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
302
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
303 @defun x-grab-pointer &optional device cursor ignore-keyboard
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
304 This function grabs the pointer and restricts it to its current window.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
305 If optional @var{device} argument is @code{nil}, the selected device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
306 will be used. If optional @var{cursor} argument is non-@code{nil},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
307 change the pointer shape to that until @code{x-ungrab-pointer} is called
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
308 (it should be an object returned by the @code{make-cursor} function).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
309 If the second optional argument @var{ignore-keyboard} is non-@code{nil},
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
310 ignore all keyboard events during the grab. Returns @code{t} if the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
311 grab is successful, @code{nil} otherwise.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
312 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
313
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
314 @defun x-ungrab-pointer &optional device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
315 This function releases a pointer grab made with @code{x-grab-pointer}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
316 If optional first arg @var{device} is @code{nil} the selected device is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
317 used. If it is @code{t} the pointer will be released on all X devices.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
318 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
319
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
320 @node X Miscellaneous
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
321 @section Miscellaneous X Functions and Variables
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
322
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
323 @defvar x-bitmap-file-path
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
324 This variable holds a list of the directories in which X bitmap files
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
325 may be found. If @code{nil}, this is initialized from the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
326 @samp{"*bitmapFilePath"} resource. This is used by the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
327 @code{make-image-instance} function (however, note that if the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
328 environment variable @samp{XBMLANGPATH} is set, it is consulted first).
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
329 @end defvar
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
330
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
331 @defvar x-library-search-path
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
332 This variable holds the search path used by @code{read-color} to find
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
333 @file{rgb.txt}.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
334 @end defvar
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
335
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
336 @defun x-valid-keysym-name-p keysym
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
337 This function returns true if @var{keysym} names a keysym that the X
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
338 library knows about. Valid keysyms are listed in the files
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
339 @file{/usr/include/X11/keysymdef.h} and in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
340 @file{/usr/lib/X11/XKeysymDB}, or whatever the equivalents are on your
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
341 system.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
342 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
343
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
344 @defun x-window-id &optional frame
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
345 This function returns the ID of the X11 window. This gives us a chance
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
346 to manipulate the Emacs window from within a different program. Since
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
347 the ID is an unsigned long, we return it as a string.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
348 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
349
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
350 @defvar x-allow-sendevents
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
351 If non-@code{nil}, synthetic events are allowed. @code{nil} means
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
352 they are ignored. Beware: allowing XEmacs to process SendEvents opens a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
353 big security hole.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
354 @end defvar
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
355
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
356 @defun x-debug-mode arg &optional device
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
357 With a true arg, make the connection to the X server synchronous. With
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
358 false, make it asynchronous. Synchronous connections are much slower,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
359 but are useful for debugging. (If you get X errors, make the connection
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
360 synchronous, and use a debugger to set a breakpoint on
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
361 @code{x_error_handler}. Your backtrace of the C stack will now be
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
362 useful. In asynchronous mode, the stack above @code{x_error_handler}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
363 isn't helpful because of buffering.) If @var{device} is not specified,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
364 the selected device is assumed.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
365
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
366 Calling this function is the same as calling the C function
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
367 @code{XSynchronize}, or starting the program with the @samp{-sync}
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
368 command line argument.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
369 @end defun
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
370
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
371 @defvar x-debug-events
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
372 If non-zero, debug information about events that XEmacs sees is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
373 displayed. Information is displayed on stderr. Currently defined
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
374 values are:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
375
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
376 @itemize @bullet
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
377 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
378 1 == non-verbose output
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
379 @item
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
380 2 == verbose output
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
381 @end itemize
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
382 @end defvar