This is xwem.info, produced by makeinfo version 4.6 from xwem.texi.

INFO-DIR-SECTION Lisp
START-INFO-DIR-ENTRY
* XWEM: (xwem).		XEMacs Window Manager.
END-INFO-DIR-ENTRY

   This manual for XWEM project version
lg@xwem.org-2004/xwem-main-2.0-version-0.

   The manual was last updated May 25, 2003.

   Copyright (C) 2003 Free Software Foundation

   This file is part of XWEM.

   XWEM is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your
option) any later version.

   XWEM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

   You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.


File: xwem.info,  Node: Top,  Next: Overview,  Up: (dir)

   This manual is part of XWEM project.  This documentatin is very
poor, so you better look at .el files for technical stuff.

   TODO: write me

* Menu:

* Overview::		An introduction.
* Getting Started::	Launching XWEM for the first time.
* Primitives::		XWEM primitives.
* Subsystems::		What is needed by Window Manager.
* Hooking::		Hooks in XWEM.
* Addons::		XWEM have some usefull packages(addons).
* Logging::		Logs facilities in XWEM.
* Licenses::		What you can't do with XWEM sources.
* Index::		This file index.

 --- The Detailed Node Listing ---

Getting Started

* Configuring X::	How to configure X server.
* Configuring Emacs::	What you need in ~/.emacs to run XWEM.
* Configuring XWEM::	How to configure XWEM.

Primitives

* Frame::		Much like Emacs frame.
* Window::		Much like Emacs window.
* Client::		Something that in XWEM window.
* XWEM Minibuffer::	Global minibuffer for Emacs frames.

XWEM Subsystems

* Keyboard::		Keyboard support.
* Mouse::		Mouse support.
* Text Specifications::	Various texts support.
* Manage Database::	How various X11 clients are managed.
* System Tray::		Support for dock applications.
* Help::		XWEM is self documented.

Keyboard

* Keymaps::		Keymaps used by XWEM.
* Keymap Operations::	What you can do with XWEM keymaps.
* Smart Modifiers::	Special modifiers mode support.


File: xwem.info,  Node: Overview,  Next: Getting Started,  Prev: Top,  Up: Top

Overview
********

XWEM is full-featured, self-documented, extensible window manager, that
works under XEmacs control.  XWEM does job other window managers do and
provides many features that other window managers not.  XWEM mostly
keyboard driven, but can handle mouse as well.

   If you are looking for very powerful tool to control X applications
or want to modify wm behaviour as you want, XWEM is for you.

   TODO: write me


File: xwem.info,  Node: Getting Started,  Next: Primitives,  Prev: Overview,  Up: Top

Getting Started
***************

You must provide some effort in way to make XWEM usable. Configuring
XWEM splits to three tasks:

* Menu:

* Configuring X::	How to configure X server.
* Configuring Emacs::	What you need in ~/.emacs to run XWEM.
* Configuring XWEM::	How to configure XWEM.


File: xwem.info,  Node: Configuring X,  Next: Configuring Emacs,  Prev: Getting Started,  Up: Getting Started

Configuring X
=============

First off all we need to configure keyboard to obtain control over XWEM.
XWEM expects that there is Hyper key setuped on your keyboard and that
Hyper key acts as modifier(i.e. in X's modifiers list).  Hyper key for
XWEM is like Meta key for XEmacs.  All default commands in XWEM uses
Hyper.  But it is not necessary to use Hyper key, but recommended.  You
can control which modifier to use by `xwem-hyper-modifier' variable
which default value is `hyper'.

   There is two ways to configure Hyper key.  One is using XKB X
extension and the other(easier) is using xmodmap application.  Find a
key(keycode) to which you want bind Hyper, using `xev'(1) utility.
Consider it is value 109.

     $ xmodmap -e "keycode 109 = Hyper_R"
     $ xmodmap -e "add mod3 = Hyper_R"

   or add following to your `~/.Xmodmap'(or whatever):

     keycode 109 = Hyper_R
     add mod3 = Hyper_R

   after that `xev' should report that keycode 109 have corresponded
Hyper_R keysym.

   Now it is time to modify a little your `~/.xinitrc'.  Who will be
your window manager?  Of course your guess about XEmacs is correct.  So
instead of running for example afterstep or fvwm you need to run XEmacs.
Part of your `~/.xinitrc' should looks like:

     # exec afterstep
     exec xemacs

   You should run `xinit', or `startx' with -tcp-listen option,
otherwise xlib will not be able to connect to X server.

   ---------- Footnotes ----------

   (1) xev utility ships with X distribution and used to report X
events and its description to user.


File: xwem.info,  Node: Configuring Emacs,  Next: Configuring XWEM,  Prev: Configuring X,  Up: Getting Started

Configuring Emacs
=================

Now we are almost ready to run XWEM.  Add something like
     (add-to-list 'load-path (expand-file-name "/path/to/xwem"))
     (require 'xwem-load)
     (xwem-init)
   at the end of your `~/.emacs'

   TODO: write how you need to configure emacs, i.e. what to need to
add in `~/.emacs'.


File: xwem.info,  Node: Configuring XWEM,  Prev: Configuring Emacs,  Up: Getting Started

Configuring XWEM
================

You can configure any of XWEM's subroutines using `~/.xwem/xwemrc.el'
file.  It will be evaluated at the top of XWEM-INIT function.

   Here is example of what you can do:

     (setq X-use-queryfont t)		; speeds up things
     
     ;; We can recreate emacs frame, so there is no problems in deleting
     ;; last frame.
     (setq allow-deletion-of-last-visible-frame t)
     
     (setq special-display-frame-plist
           (plist-put special-display-frame-plist 'height 50))
     
     (defadvice kill-buffer (before delete-dedicated-frame activate)
       "Work around dedicated frame problem."
       (let ((frame (buffer-dedicated-frame
                     (get-buffer (or (ad-get-arg 0) (current-buffer))))))
         (when (framep frame)
           (delete-frame frame))))
     
     ;; Icons
     ;(setq xwem-icons-dir "~/prog/emacs/xwem/icons")
     (pushnew '([".*freebsd.*" "xterm" "XTerm"] . "mini-daemon.xpm")
        xwem-icons-alist)
     (pushnew '([".*xwem.*" "emacs" "Emacs"] . "mini-xwem.xpm")
        xwem-icons-alist)
     
     ;;; Customize XWEM variables
     (setq xwem-minibuffer-active-border-color "cyan2"
           xwem-default-focus-mode 'follow-mouse
           xwem-edmacro-can-edit-nonmacro t
           )
     
     (define-abbrev-table 'xwem-launcher-abbrev-table
       '(("gterm" "xterm -fg green -hc green4" nil 0)
         ("gfterm" "xterm -fg green -hc green4 -fn fixed" nil 0)
         ("aqterm" "xterm -fg aquamarine -hc aquamarine4" nil 0)
         ("aqfterm" "xterm -fg aqua -hc aqua4 -fn fixed" nil 0)
         ("gsterm" "xterm -fg darkseagreen1 -hc darkseagreen4" nil 0)
         ("gsfterm"
          "xterm -fg darkseagreen1 -hc darkseagreen4 -fn fixed" nil 0)
         ("oterm" "xterm -fg OliveDrab1 -hc OliveDrab4" nil 0)
         ("ofterm" "xterm -fg OliveDrab1 -hc OliveDrab4 -fn fixed" nil 0)
         ("orterm" "xterm -fg orange -hc orange4" nil 0)
         ("orfterm" "xterm -fg orange -hc orange4 -fn fixed" nil 0)
         ))
     
     ;; Add sounds, beeping type
     (xwem-sound-load-default t)
     
     ;;; Addons
     
     ;; Buqis like client switcher
     (xwem-clswi-enable)
     
     ;; `display-time' like stuff in system tray
     ;(add-hook 'xwem-after-init-hook 'xwem-time)
     
     ;; H-6, H-x /, H-x j bindings
     (require 'xwem-register)
     (xwem-register-install-bindings)
     
     ;; Nice frame indicator
     (autoload 'xwem-framei-init "xwem-framei")
     (add-hook 'xwem-after-init-hook 'xwem-framei-init)
     
     ;; Making holer in frames
     (require 'xwem-holer)
     (define-key xwem-global-map (xwem-kbd "H-x h") 'xwem-holer-prefix)
     
     ;; Nice rooter addon
     (require 'xwem-rooter)
     (xwem-rooter-add-client 'xwem-xclock-onroot "^xclock$")
     (xwem-rooter-add-client 'xwem-gkrellm-onroot "^gkrellm$")
     
     ;; Worklog
     (require 'xwem-worklog)
     (define-key xwem-global-map (xwem-kbd "H-w") 'xwem-worklog-prefix)
     
     ;; Fast frame switcher
     (defun my-xwem-switch-frame (key)
       "To be used by H-C-<digit> bindings."
       (interactive (list (event-key xwem-last-event)))
       (xwem-frame-switch-nth (- (char-to-int key) 48)))
     
     (define-key xwem-global-map (xwem-kbd "H-C-0") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-1") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-2") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-3") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-4") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-5") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-6") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-7") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-8") 'my-xwem-switch-frame)
     (define-key xwem-global-map (xwem-kbd "H-C-9") 'my-xwem-switch-frame)

   TODO: write me


File: xwem.info,  Node: Primitives,  Next: Subsystems,  Prev: Getting Started,  Up: Top

Primitives
**********

Here is introduction to XWEM primitives, such as Frame, Window, Client,
minibuffer, specials, etc.

* Menu:

* Frame::		Much like Emacs frame.
* Window::		Much like Emacs window.
* Client::		Something that in XWEM window.
* XWEM Minibuffer::	Global minibuffer for Emacs frames.


File: xwem.info,  Node: Frame,  Next: Window,  Prev: Primitives,  Up: Primitives

Frame
=====

"Frame" is general thing that used to hold XWEM windows(*note
Window::).  Usually Frame have something like titlebar which is used to
display information related to manager state, such as names for XWEM
Clients(*note Client::) or user defined information.

   TODO: add some info about Frames properties, such as GCs list, root
window, selected window, etc.

 - Function: xwem-frame-p frame
     Returns non-`nil' if FRAME is XWEM Frame.

* Menu:

* Basic Frames::                Basic description for Frames.
* Creating Frames::             Creating Frames.
* Frame Properties::            Controlling frame's size, position, etc.
* Frame Title::                 Using frame title to display information.
* Deleting Frames::             How to delete frames.
* Frames Operations::           What you can do with Frames.
* Embedded Frames::             Frame may be normal XWEM client.
* Frames variables and functions::


File: xwem.info,  Node: Basic Frames,  Next: Creating Frames,  Prev: Frame,  Up: Frame

Basic Frames
------------

TODO: write me


File: xwem.info,  Node: Creating Frames,  Next: Frame Properties,  Prev: Basic Frames,  Up: Frame

Creating Frames
---------------

Here is describe functions which is used to create frames.  Also
describe default bindings to create frames.  Describe side by side
splits.

   TODO: write me


File: xwem.info,  Node: Frame Properties,  Next: Frame Title,  Prev: Creating Frames,  Up: Frame

Frame Properties
----------------

Each XWEM Frame have properties list, which is altered when creating
Frame.

   Here should be description of Frame's properties, default values,
etc.

   TODO: write me


File: xwem.info,  Node: Frame Title,  Next: Deleting Frames,  Prev: Frame Properties,  Up: Frame

Frame Title
-----------

Description of Frame tabber.

   TODO: write me


File: xwem.info,  Node: Deleting Frames,  Next: Frames Operations,  Prev: Frame Title,  Up: Frame

Deleting Frames
---------------

You may easily delete any of XWEM Frame.  All clients that have Frame as
parent window will be reparented to root window.

   Here is should be description for default keybindings for frame
deletion and functions description.

   TODO: write me


File: xwem.info,  Node: Frames Operations,  Next: Embedded Frames,  Prev: Deleting Frames,  Up: Frame

Frames Operations
-----------------

Here is description about what you can do with Frame.  Switching,
linkage switching, etc.

   TODO: write me


File: xwem.info,  Node: Embedded Frames,  Next: Frames variables and functions,  Prev: Frames Operations,  Up: Frame

Embedded Frames
---------------

"Embedded Frame" is Frame and CL at the same time.

   Here is description on how to create embedded frames, how to unembed
them and so on.

   TODO: write me


File: xwem.info,  Node: Frames variables and functions,  Prev: Embedded Frames,  Up: Frame

Frames variables and functions
------------------------------

 - Variable: xwem-frame-background
     This is symbol specifies background color used in XWEM Frame. This
     color should be in `xwem-gc-syscolors' or in
     `xwem-gc-bonus-colors'.
          xwem-frame-backgroud
          => "gray60"

 - Variable: xwem-frame-cursor-shape
     This specifies shape of cursor when pointer is over XWEM Frame. It
     is value of one of `X-XC-'... variable.

          (eq xwem-frame-cursor-shape 'X-XC-left_ptr)
          => t

 - Variable: xwem-frame-cursor-foreground-color
     Specifies cursor's foreground color when pointer is over XWEM
     Frame.

          xwem-frame-cursor-foreground-color
          => "#002800"

 - Variable: xwem-frame-cursor-background-color
     Cursor's background color when pointer over XWEM Frame.

 - Variable: xwem-frame-defprops
     Plist which is used to define default properties for newly created
     XWEM Frames.  Keys in this plist is symbols, you can use one of:

     `title-height' - Height in pixels to be used for title bar.

     `inner-border-width' - Width in pixels of XWEM Frame's inner
     border.

     `otter-border-width' - Width in pixels of XWEM Frame's otter
     border.

     `title-thickness' - Used for 3D view of title bar.

          xwem-frame-defprops
          =>
          (inner-border-width 0
           otter-border-width 0
           title-height 17
           title-thickness 2)

 - Variable: xwem-face-frame-selected-win-selected
     Face used to outline selected Window in selected Frame.

 - Variable: xwem-face-frame-selected-win-nonselected
     Face used to outline non-selected Window in selected Frame.

 - Variable: xwem-face-frame-nonselected-win-selected
     Face to outline selected Window in non-selected Frame.

 - Variable: xwem-face-frame-nonselected-win-nonselected
     Face to outline non-selected Window in non-selected Frame.

 - Variable: xwem-face-win-delimeter
     Face to draw Window delimeter.

 - Variable: xwem-face-win-delimeter-shadow
     Face to draw shadow of Window delimeter.

 - Variable: xwem-frame-rolling-switch
     Non-nil mean that `xwem-frame-next' and `xwem-frame-previous'
     commands will always switch, even if there no next or previous
     Frame.

 - Variable: xwem-frame-switch-hook
     Hooks to be called when Frame switching occurs (i.e.
     `xwem-current-frame' changes).  Function will receive two
     arguments OLD-FRAME and NEW-FRAME.

 - Variable: xwem-frame-keymap
     Keymap used in Frames.

 - Variable: xwem-frames-list
     List of all Frames.

 - Variable: xwem-current-frame
     Refers to currently selected Frame.

 - Function: xwem-frame-p frame
     Return non-`nil' if FRAME is valid XWEM Frame.

          (xwem-frame-p t)
          => nil

 - Function: xwem-frame-alive-p frame
     Return non-`nil' if FRAME is alive frame, i.e. in
     `xwem-frames-list'.

 - Function: xwem-frame-mapped-p frame
     Return non-`nil' if FRAME is mapped, i.e. its contents shown.

 - Function: xwem-frame-map frame
     Map FRAME, i.e show it contents.

 - Function: xwem-frame-selected
     Return currently selected Frame.

 - Function: xwem-frame-selected-p frame
     Return non-`nil' if FRAME is selected Frame.

 - Function: xwem-frame-select frame &optional dnr-hooks
     Make FRAME to be selected.  Runs `xwem-frame-switch-hooks' if
     FRAME is not already selected and DNR-HOOKS non-`nil'.

 - Function: xwem-frame-select-defhook old-frame new-frame
     Default hook that present in `xwem-frame-switch-hooks'.

   TODO: describe other functions ..

 - Function: xwem-init-frames
     Initialise all stuff needed to manipulate with XWEM Frames.

 - Function: xwem-make-frame props
     Creates new Frame with merged `xwem-frame-defprops' and PROPS
     together properties.

 - Function: xwem-find-frame xwin
     Find Frame by X Window XWIN

 - Function: xwem-frame-find how arg
     Find Frame according to HOW and ARG.  HOW can be one of `xwin',
     `win' or `cl'.  ARG is X Window, XWEM Window or XWEM Client
     respectively.

 - Function: xwem-frame-num frame
     Return index position of FRAME in `xwem-frame-list'.

 - Function: xwem-frame-draw frame fully
     Draw FRAME.  If FULLY is non-`nil' then `XClearArea' Frame's X
     window before drawing.

 - Function: xwem-frame-redraw frame
     Outlines Windows inside FRAME.

 - Function: xwem-frame-switch-nth n
     Switch to N XWEM Frame in `xwem-frame-list'.

 - Function: xwem-frame-del-win &optional frame window
     Removes XWEM WINDOW from XWEM FRAME.

 - Function: xwem-frame-del-others &optional frame window
     Removes all XWEM Windows from XWEM FRAME other then WINDOW.

 - Function: xwem-frame-split-horiz &optional frame
     Splits XWEM FRAME horizontally.

 - Function: xwem-frame-split-vert &optional frame
     Splits XWEM FRAME vertically.

 - Function: xwem-frame-win-enlarge-hor n
     Enlarges `xwem-win-selected' in `xwem-frame-selected' by n pixels
     horizontally.

 - Function: xwem-frame-win-enlarge-ver n
     Enlarges `xwem-win-selected' in `xwem-frame-selected' by n pixels
     vertically.

 - Function: xwem-frame-goto direction &optional frame
     Go to next XWEM Window in FRAME in DIRECTION.


File: xwem.info,  Node: Window,  Next: Client,  Prev: Frame,  Up: Primitives

Window
======

In this chapter we will discuss thing related to XWEM's Windows.

* Menu:

* Basic Windows::               Basic information on Windows.
* Splitting Windows::           Splitting Window into two.
* Deleting Windows::            How you should delete Windows.
* Selecting Windows::           Selected Window.
* Cycling Windows::             Moving around Windows.
* Resizing Windows::            Changing size of Windows.
* Window Configurations::       Saving and restoring layout of Windows.
* Drawing Windows::             How Windows stuff are drawed.
* Window Expectances::          Window can wait for a particular client.


File: xwem.info,  Node: Basic Windows,  Next: Splitting Windows,  Prev: Window,  Up: Window

Basic Windows
-------------

"Window" is subpart of Frame(*note Frame::) that holds Clients (*note
Client::).  Each Frame always contain at least one Window, but you con
divide it vertically or horizontally to obtain new Windows.  Windows
never overlaps.  There is always selected Window in each Frame, but it
is not guaranties that Client in selected Window will have input focus.

 - Function: xwem-init-win
     Initilizes all stuff we will need.

 - Variable: xwem-win-default-properties
     Plist of default properties for newly created Windows.  Keys in
     list is one of symbol:
        * `dead' Window referenced but not workable.

        * `deleted' Deleted Windows have this non-`nil'.

        * `frame' Reference to XWEM Frame.

        * `next' Next window in windows double linked list.

        * `prev' Previous window in windows double linked list.

        * `hchild' Horizontal child.

        * `vchild' Vertical child.

        * `client' Link to XWEM Client that is in XWEM Window or `nil'.

        * `expectances' Expectances plist for XWEM Window.

 - Function: xwem-win-p win
     Return non-`nil' if WIN is Window.


File: xwem.info,  Node: Splitting Windows,  Next: Deleting Windows,  Prev: Basic Windows,  Up: Window

Splitting Windows
-----------------

Functions described here is used in way to split XWEM's window or get
information about split.

 - Variable: xwem-win-min-width
     Minimal width in pixels that XWEM Window may have after spliting.

          xwem-win-min-width
          => 40

 - Variable: xwem-win-min-height
     Minimal height in pixels that XWEM Window may have after spliting.

          xwem-win-min-height
          => 40

 - Function: xwem-win-split &optional window how new-size
     Splits XWEM WINDOW, HOW is one of `vertical' or
     `horizontal'(default is `horizontal').  NEW-SIZE is size in pixels
     which should have WINDOW after split.

 - Function: xwem-win-only-one-p &optional window
     Returns non-`nil' if WINDOW is only one in XWEM Windows chain.


File: xwem.info,  Node: Deleting Windows,  Next: Selecting Windows,  Prev: Splitting Windows,  Up: Window

Deleting Windows
----------------

 - Function: xwem-window-delete &optional window
     Deletes XWEM WINDOW. If ommited than `xwem-win-selected' will be
     used.

 - Function: xwem-window-delete-others &optional window
     Deletes all XWEM Windows other then WINDOW.

 - Function: xwem-win-delete-subwindows window
     Mark all child of XWEM WINDOW as deleted.

 - Function: xwem-win-mark-deleted window


File: xwem.info,  Node: Selecting Windows,  Next: Cycling Windows,  Prev: Deleting Windows,  Up: Window

Selecting Windows
-----------------

Select a window means that client currently in than window receives
input focus.

 - Variable: xwem-win-switch-hook
     Hooks that will be runned when selected window changes.  Functions
     in should accept two arguments - `old-win' and `new-win'.

          xwem-win-switch-hook
          => (xwem-win-focus xwem-win-title)

 - Function: xwem-win-selected
     Returns selected XWEM Window.

 - Function: xwem-win-selected-p window
     Return non-`nil' if WINDOW is selected.

 - Function: xwem-window-select window
     Select WINDOW as current XWEM Window. Runs `xwem-win-switch-hooks'.


File: xwem.info,  Node: Cycling Windows,  Next: Resizing Windows,  Prev: Selecting Windows,  Up: Window

Cycling Windows
---------------

 - Function: xwem-win-make-list-by-next window
     Creates list of XWEM Windows using `next' property.

 - Function: xwem-win-new props
     Creates new XWEM Window using properties obtained after merging
     `xwem-window-defprops' and PROPS together.

 - Function: xwem-win-replace oldw neww
     Replace OLDW XWEM Window with contents of NEWW XWEM Window.

 - Function: xwem-win-make-parent window
     Creates dummy parent XWEM Window for WINDOW.

 - Function: xwem-window-next &optional window
     Returns next XWEM Window after WINDOW in canonical ordering.

 - Function: xwem-window-next-vertical &optional window
     Returns XWEM Window which is vertically after WINDOW.

 - Function: xwem-window-prev &optional window
     Returns previous XWEM Window before WINDOW in canonical ordering
     of XWEM Windows.

 - Function: xwem-win-map fn &optional window
     Apply FN function to WINDOW and each child of it. FN will be
     called with an XWEM Window as argument.

 - Function: xwem-win-count &optional window
     Count childs in WINDOW.

 - Function: xwem-window-list &optional frame
     nil

   Here is somelike windmove package.

 - Function: xwem-winmove-left &optional arg
     Move to the left.  TODO: describe ARG.

 - Function: xwem-winmove-right &optional arg
     Move to the right.  TODO: describe ARG.

 - Function: xwem-winmove-up &optional arg
     Move to the up.  TODO: describe ARG.

 - Function: xwem-winmove-down &optional arg
     Move to the down.  TODO: describe ARG.

   TODO: write me


File: xwem.info,  Node: Resizing Windows,  Next: Window Configurations,  Prev: Cycling Windows,  Up: Window

Resizing Windows
----------------

Here functions that operations on window's sizes.

 - Function: xwem-window-set-pixsize window nsize nodelete is-height
     Sets size of WINDOW to NSIZE in pixels.  If IS-HEIGHT is non-`nil'
     then nsize is new WINDOW height.

 - Function: xwem-window-change-size window delta height-p
     Changes XWEM WINDOW size to old-size plus DELTA. HEIGHT-P is
     non-`nil' if height changes.

   TODO: add shrink and enlarge


File: xwem.info,  Node: Window Configurations,  Next: Drawing Windows,  Prev: Resizing Windows,  Up: Window

Window Configurations
---------------------

 - Function: xwem-window-configuration &optional frame
     Return current Windows configuration for FRAME.  You can restore
     it than using `xwem-set-window-configuration'.

 - Function: xwem-set-window-configuration win-config
     Restore window configuration WIN-CONFIG, returned by
     `xwem-window-configuration'.


File: xwem.info,  Node: Drawing Windows,  Next: Window Expectances,  Prev: Window Configurations,  Up: Window

Drawing Windows
---------------

 - Variable: xwem-win-delim-width
     XWEM Window delimeter width in pixels, including shadow.

 - Variable: xwem-win-delim-shadow-thicksness
     When drawing 3D shadows for XWEM Window delimeters, this variable
     used.

 - Function: xwem-win-draw-delims window
     Draws delimeters in XWEM WINDOW.


File: xwem.info,  Node: Window Expectances,  Prev: Drawing Windows,  Up: Window

Window Expectances
------------------

"Expectances" is thing describes which clients cirtain XWEM Window wait
to manage.

   TODO: write me


File: xwem.info,  Node: Client,  Next: XWEM Minibuffer,  Prev: Window,  Up: Primitives

Client
======

"Client" is normal X11 application already managed by XWEM. All XWEM
Clients manages according to XWEM Manage Database(*note Manage
Database::). Default behaviour is to enlarge each XWEM Client which have
no override redirect flag ot XWEM Window used to hold that Client.

* Menu:

* Client Basics::               What is Client.
* Client Properties::           Describes what properties have each Client.
* Current Client::              There is always some Client is active.
* Clients Lists::               How does Clients organizes lists.
* Client Hooks::                How you can control Clients.
* Operating on Clients::        What you can do with Clients.


File: xwem.info,  Node: Client Basics,  Next: Client Properties,  Prev: Client,  Up: Client

Client Basics
-------------

TODO: describe what is XWEM Client.

 - Function: xwem-cl-p client
     Returns non-`nil' if CLIENT is Client.


File: xwem.info,  Node: Client Properties,  Next: Current Client,  Prev: Client Basics,  Up: Client

Client Properties
-----------------

Each Client in XWEM have some properties associated with it.

 - Function: xwem-client-name cl &optional clist
     Return unique name for Client CL using CLIST as list of Clients.


File: xwem.info,  Node: Current Client,  Next: Clients Lists,  Prev: Client Properties,  Up: Client

Current Client
--------------

"Current Client" is client in selected Window.

   TODO: describe things related to special XEmacs frames.

 - Function: xwem-cl-selected
     Return selected Client.


File: xwem.info,  Node: Clients Lists,  Next: Client Hooks,  Prev: Current Client,  Up: Client

Clients Lists
-------------

TODO: describe client lists.

 - Variable: xwem-clients
     List of all Clients.


File: xwem.info,  Node: Client Hooks,  Next: Operating on Clients,  Prev: Clients Lists,  Up: Client

Client Hooks
------------

TODO: genaral overview of hooks used in Client processing.

 - Variable: xwem-cl-setup-hooks
     List of hooks which is called after XWEM Client is managed.
     Functions in that list should accept one argument - XWEM Client.

 - Variable: xwem-cl-manage-hook
     Functions to call when Client managed.  They are passed with one
     argument - `cl'.

 - Variable: xwem-cl-demanage-hook
     Functions to call when Cliend demanages.  Called with with one
     argument - `cl'.


File: xwem.info,  Node: Operating on Clients,  Prev: Client Hooks,  Up: Client

Operating on Clients
--------------------

Here is some usefull functions you can use to operate on Clients.

 - Function: xwem-find-client xwin-or-id
     Find Client by X window XWIN-OR-ID.

 - Function: xwem-remove-client cl
     Remove CL from Clients list `xwem-clients'.

   TODO: write me


File: xwem.info,  Node: XWEM Minibuffer,  Prev: Client,  Up: Primitives

XWEM Minibuffer
===============

"XWEM minibuffer" is global minibuffer(usually value of
DEFAULT-MINIBUFFER-FRAME) used as minibuffer by all XEmacs frames.

   TODO: write me


File: xwem.info,  Node: Subsystems,  Next: Hooking,  Prev: Primitives,  Up: Top

XWEM Subsystems
***************

There many subsystems in XWEM. Such as keyboard operations, pointer
operations, text and graphical contexts operations, manage database
operations and so on.

   TODO: write me

* Menu:

* Keyboard::		Keyboard support.
* Mouse::		Mouse support.
* Text Specifications::	Various texts support.
* Manage Database::	How various X11 clients are managed.
* System Tray::		Make your xwem minibuffer to be a dockapp holder.
* Help::		XWEM is self documented.


File: xwem.info,  Node: Keyboard,  Next: Mouse,  Prev: Subsystems,  Up: Subsystems

Keyboard
========

Keyboard support in XWEM is much like how XEmacs deals with keyboard
i.e. keymap notation used to interpret key sequences to commands
relation.

* Menu:

* Keymaps::		Keymaps used by XWEM.
* Keymap Operations::	What you can do with XWEM keymaps.
* Smart Modifiers::	Special modifiers mode support.


File: xwem.info,  Node: Keymaps,  Next: Keymap Operations,  Prev: Keyboard,  Up: Keyboard

Keymaps
-------

Keymaps used in XWEM is:

 - Variable: xwem-global-map
     This is global XWEM keymap.

 - Variable: xwem-help-map
     Keymap for help commands.

 - Variable: xwem-hyp-x-map
     This keymap is for Hyper-X commands.

 - Variable: xwem-hyp-x-4-map
     Keymap for Hyper-X-4 commands.

 - Variable: xwem-hyp-x-5-map
     Keymap for Hyper-X-5 commands.

 - Variable: xwem-hyp-x-7-map
     Keymap for Hyper-X-7 commands.

 - Variable: xwem-launcher-map
     Keymap for XWEM launcher.

 - Variable: xwem-launcher-other-win-map
     Keymap for launcher commands in other Window.

 - Variable: xwem-launcher-other-frame-map
     Keymap for launcher commands in other Frame.

 - Variable: xwem-user-macros-map
     Keymap for user's keyboard macros.

 - Variable: xwem-hyp-resize-map
     Keymap for Window resize commands.


File: xwem.info,  Node: Keymap Operations,  Next: Smart Modifiers,  Prev: Keymaps,  Up: Keyboard

Keymap Operations
-----------------

TODO: write me


File: xwem.info,  Node: Smart Modifiers,  Prev: Keymap Operations,  Up: Keyboard

Smart Modifiers
---------------

"Smart modifier" is key which can act as modifier when it is used in
combination with some other key and as normal key when it is just
clicked i.e. pressed and released.

   To use smart modifiers you must set `(setq xwem-use-smart-modifiers
t)', default is `nil'. And add items to `xwem-key-smart-modifiers'.
Item is vector in form `[Modifier-keysym Key-Keysym nil nil]'. Second
and third elements is used internally and it is no need to fill them.

   Example:
     (add-to-list 'xwem-key-smart-modifiers (vector XK-Control-R XK-Space nil
     nil))
             => add right control to active grabs and send space key
             when it is clicked.


File: xwem.info,  Node: Mouse,  Next: Text Specifications,  Prev: Keyboard,  Up: Subsystems

Mouse
=====

When I was planning to write XWEM I thought that mouse support will be
minimal, but when I played a little with X11 stuff I realized where
mouse may be used to get really useful functionality. Main mouse feature
over keyboard is that you can generate multiple movement or button
press/release events in a moment. It can be used to interact with
Strokes.

   "Stroke" is some mouse motion which yields some command.

   TODO: xwem strokes description.

   TODO: popup menus description.


File: xwem.info,  Node: Text Specifications,  Next: Manage Database,  Prev: Mouse,  Up: Subsystems

Text
====

"Text Specification" is list of conses in form `(lala-text . GC)'.

   TODO: write me


File: xwem.info,  Node: Manage Database,  Next: System Tray,  Prev: Text Specifications,  Up: Subsystems

Manage Database
===============

"Manage Database" is list of some information about certain X11
applications.  It contain info about how to deal with that X11
application, how it should managed, demanaged, iconified, refited, etc.

   TODO: write me


File: xwem.info,  Node: System Tray,  Next: Help,  Prev: Manage Database,  Up: Subsystems

System Tray
===========

"System Tray" is some area in your screen, that used to hold some X
applications called dock applications or dockapps in short.  XWEM's
system tray uses *Note XWEM Minibuffer:: as that area, so you does not
lost it.  It is morden to implement system tray using XEMBED protocol,
which describes how dockapps and tray window should communicate.  XWEM's
system tray uses extended version of XEMBED protocol, which allow any
dockapp to run Emacs Lisp!

 - Variable: xwem-tray-enabled
     Non-`nil' mean that System tray will be used by XWEM.

 - Variable: xwem-tray-max-docks
     Maximum number of dockapps to be used in system tray.  If value is
     to much, than system tray may eat too much space in XWEM's
     minibuffer and you will not be able to comfortable interact with
     it. Default value is 6.

 - Variable: xwem-tray-minib-position
     Symbol that may be `'right' or `'left' specifies position in
     XWEM's minibuffer where first dockapp appears.

 - Variable: xwem-tray-minib-posoffset
     Offset in pixels from XWEM's minibuffer edge.

 - Variable: xwem-tray-minib-docoffset
     Offset in pixels between two dockapps.

 - Variable: xwem-tray-cursor-shape
     Shape of cursor when pointer is over one of dockapp, see `X-XC-XXX'
     constants values. Default is value of `X-XC-right_ptr'.

 - Variable: xwem-tray-cursor-foreground-color
     Specifies foreground color of cursor, when pointer is over one of
     dockapp.

 - Variable: xwem-tray-cursor-background-color
     Cursor's background color, when pointer over System tray.

 - Variable: xwem-tray-config
     This is a list of vectors and each vector is in form `[type
     value]'. Type is one of `XWEM-TRAY-DOCK' or `XWEM-TRAY-DELIM'. If
     type is `XWEM-TRAY-DOCK' than value is string and it specifies
     program and program's arguments you need to launch and put in
     system tray. If type is `XWEM-TRAY-DELIM' than value is integer,
     which specifies offset in pixels to be inserted in system tray.
          xwem-tray-config
          =>
          ([XWEM-TRAY-DOCK "/path/to/xwem-minitime -f 004400 -b bbbbbb"]
           [XWEM-TRAY-DOCK "/path/to/xwem-miniapm"]
           [XWEM-TRAY-DELIM 10]
           [XWEM-TRAY-DOCK "path/to/xwem-minilaunch
                            -l /path/to/icons/xterm.xpm xterm"]
           [XWEM-TRAY-DOCK "/path/to/xwem-minilaunch
                            -l /path/to/icons/xterm_big.xpm
                            xterm -fn 10x20"]
           [XWEM-TRAY-DOCK "/path/to/xwem-minilaunch
                            -e \"(make-frame)\"
                            /path/to/icons/xemacs.xpm emacs"]
           [XWEM-TRAY-DOCK "/path/to/xwem-minilaunch
                            -l /path/to/icons/netscape.xpm
                            netscape"])

 - Function: xwem-tray-run-config &optional config
     This function takes CONFIG in format described above, and executes
     it.  See example of its usage.
          (add-hook 'xwem-after-init-hooks 'xwem-tray-run-config)


File: xwem.info,  Node: Help,  Prev: System Tray,  Up: Subsystems

Help
====

Help subsysem in XWEM is much like XEmacs help subsystem.

   TODO: write me


File: xwem.info,  Node: Hooking,  Next: Addons,  Prev: Subsystems,  Up: Top

Hooking
*******

XWEM supports multiple hooks across its routines.  Here is some basic
hooks that you can use to alter XWEM behaviour.

   TODO: write me


File: xwem.info,  Node: Addons,  Next: Logging,  Prev: Hooking,  Up: Top

Addons
******

XWEM have some usefull packages in its distribution.

   * `xwem-clswi.el' Buqis like client switching.

   * `xwem-diagram.el' Diagram drawer for XWEM.
        - Bars diagrams.

        - Circle digrams.

        - Plain digrams.

        - 3D digrams.

   * `xwem-edmacro.el' Addon to edit keyboard macros.

   * `xwem-framei.el' Frame indicator.

   * `xwem-gamma.el' Interactive gamma corrector.

   * `xwem-holer.el' Create holes in Frames.

   * `xwem-osd.el' On Screen Display for XWEM.

   * `xwem-register.el' Registers for XWEM.

   * `xwem-rooter.el' Handle Clients on root window.

   * `xwem-time.el' `display-time' like dockapp.

   * `xwem-worklog.el' Keep track on what you are doing.

   * `xwem-xfig.el' XFIG format.


   TODO: more packages description, tutorial on how to write XWEM
packages.


File: xwem.info,  Node: Logging,  Next: Licenses,  Prev: Addons,  Up: Top

Logging
*******

XWEM support some logging facilities.  Add next to your
`~/.xwem/xwemrc.el':

     (setq xwem-debug t)

   If you want more debugging stuff, you can use `xmond' utility.

   TODO: write me


File: xwem.info,  Node: Licenses,  Next: Index,  Prev: Logging,  Up: Top

Licenses
********

I think there is must be GPL text.


File: xwem.info,  Node: Index,  Prev: Licenses,  Up: Top

Index
*****

* Menu:

* Addons:                                Addons.
* Basic Frames:                          Basic Frames.
* basics <1>:                            Basic Windows.
* basics:                                Client Basics.
* client:                                Client.
* configuring <1>:                       Configuring X.
* configuring <2>:                       Configuring Emacs.
* configuring:                           Configuring XWEM.
* Creating Frames:                       Creating Frames.
* cycling:                               Cycling Windows.
* deleting:                              Deleting Windows.
* Deleting Frames:                       Deleting Frames.
* drawing:                               Drawing Windows.
* Embedded Frames:                       Embedded Frames.
* expectances:                           Window Expectances.
* Frame:                                 Frame.
* Frame Properties:                      Frame Properties.
* Frame Title:                           Frame Title.
* Frames Operations:                     Frames Operations.
* help:                                  Help.
* hooking:                               Hooking.
* hooks:                                 Client Hooks.
* keyboard:                              Keyboard.
* keymap <1>:                            Keymaps.
* keymap:                                Keymap Operations.
* license:                               Licenses.
* lists:                                 Clients Lists.
* logging:                               Logging.
* manage:                                Manage Database.
* minibuffer:                            XWEM Minibuffer.
* modifiers:                             Smart Modifiers.
* mouse:                                 Mouse.
* operating:                             Operating on Clients.
* overview:                              Overview.
* primitives:                            Primitives.
* properties:                            Client Properties.
* resizing:                              Resizing Windows.
* selecting:                             Selecting Windows.
* splitting:                             Splitting Windows.
* starting:                              Getting Started.
* strokes:                               Mouse.
* subsystem:                             Subsystems.
* text font:                             Text Specifications.
* tray:                                  System Tray.
* window:                                Window.
* window configurations:                 Window Configurations.
* XEMBED:                                System Tray.



Tag Table:
Node: Top1051
Node: Overview2438
Node: Getting Started2951
Node: Configuring X3331
Ref: Configuring X-Footnote-14892
Node: Configuring Emacs4995
Node: Configuring XWEM5434
Node: Primitives9512
Node: Frame9905
Node: Basic Frames10924
Node: Creating Frames11057
Node: Frame Properties11351
Node: Frame Title11657
Node: Deleting Frames11831
Node: Frames Operations12211
Node: Embedded Frames12463
Node: Frames variables and functions12776
Node: Window18123
Node: Basic Windows18847
Node: Splitting Windows20089
Node: Deleting Windows20976
Node: Selecting Windows21495
Node: Cycling Windows22234
Node: Resizing Windows23902
Node: Window Configurations24472
Node: Drawing Windows24953
Node: Window Expectances25405
Node: Client25630
Node: Client Basics26402
Node: Client Properties26638
Node: Current Client26960
Node: Clients Lists27262
Node: Client Hooks27472
Node: Operating on Clients28084
Node: XWEM Minibuffer28463
Node: Subsystems28714
Node: Keyboard29282
Node: Keymaps29686
Node: Keymap Operations30615
Node: Smart Modifiers30768
Node: Mouse31540
Node: Text Specifications32135
Node: Manage Database32335
Node: System Tray32695
Node: Help35823
Node: Hooking35981
Node: Addons36215
Node: Logging37120
Node: Licenses37404
Node: Index37535

End Tag Table
