xim.txt

linux 下的 oxim 输入法,简单易用.

following reasons: the argument name is not recognized,  or  the  input  method
encountered an input method implementation dependent error.

3.3.  IC Values Arguments

The following tables describe how IC values are interpreted by an input  method
depending on the input style chosen by the user.

The first column lists the IC values.  The second column indicates which values
are  involved  in  affecting, negotiating and setting the geometry of the input
method windows.  The sub-entries under the third column indicate the  different
input  styles  supported.   Each  of these columns indicates how each of the IC
values are treated by that input style.

















                             16





XIM Public Review Draft


___________________________________________________________________________________________
|                    ||           ||__________________________________________________|
|                    || Geometry  ||PreEdit  | PreEdit  | PreEdit | PreEdit | PreEdit |
|     IC Value       ||Management ||Callback | Position |  Area   | Nothing |  None   |
______________________________________________________________________________________|
|Input Style         ||           ||  C-G    |   C-G    |   C-G   |   C-G   |   C-G   |
|Client Window       ||           ||  O-G    |   O-G    |   O-G   | ignored | ignored |
|Focus Window        ||    GN     || D-S-G   |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|Resource Name       ||           ||ignored  |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|Resource Class      ||           ||ignored  |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|Geometry Callback   ||           ||ignored  | ignored  |  D-S-G  | ignored | ignored |
______________________________________________________________________________________|
|PreEdit             ||           ||         |          |         |         |         |
|- Area              ||    GS     ||ignored  |  D-S-G   |  D-S-G  | ignored | ignored |
|- AreaNeeded        ||  GN-GR    ||ignored  | ignored  |   S-G   | ignored | ignored |
|- SpotLocation      ||           ||ignored  |  C-S-G   | ignored | ignored | ignored |
|- Colormap          ||           ||ignored  |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|- Fg/Bg             ||           ||ignored  |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|- Bg Pixmap         ||           ||ignored  |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|- FontSet           ||    GN     ||ignored  |  C-S-G   |  C-S-G  |  D-S-G  | ignored |
|- LineSpacing       ||    GN     ||ignored  |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|- Cursor            ||           ||ignored  |  D-S-G   |  D-S-G  |  D-S-G  | ignored |
|- PreEdit Callbacks ||           || C-S-G   | ignored  | ignored | ignored | ignored |
|____________________||___________||_________|__________|_________|_________|_________|

  __________________________________________________________________________
  |                   ||           ||             Input Style               |
  |                   ||           ||_______________________________________|
  |     IC Value      || Geometry  || Status  | Status  | Status  | Status  |
  __________________________________________________________________________|
  |Input Style        ||           ||  C-G    |   C-G   |   C-G   |   C-G   |
  |Client Window      ||           ||  O-G    |   O-G   |   O-G   | ignored |
  |Focus Window       ||    GN     || D-S-G   |  D-S-G  |  D-S-G  | ignored |
  |Resource Name      ||           ||ignored  |  D-S-G  |  D-S-G  | ignored |
  |Resource Class     ||           ||ignored  |  D-S-G  |  D-S-G  | ignored |
  |Geometry Callback  ||           ||ignored  |  D-S-G  | ignored | ignored |
  |FilterEvents       ||           ||   G     |    G    |    G    |    G    |
  __________________________________________________________________________|
  |Status             ||           ||         |         |         |         |
  |- Area             ||    GS     ||ignored  |  D-S-G  | ignored | ignored |
  |- AreaNeeded       ||  GN-GR    ||ignored  |   S-G   | ignored | ignored |
  |- Colormap         ||           ||ignored  |  D-S-G  |  D-S-G  | ignored |
  |- Fg/Bg            ||           ||ignored  |  D-S-G  |  D-S-G  | ignored |
  |- Bg Pixmap        ||           ||ignored  |  D-S-G  |  D-S-G  | ignored |
  |- FontSet          ||    GN     ||ignored  |  C-S-G  |  D-S-G  | ignored |
  |- LineSpacing      ||    GN     ||ignored  |  D-S-G  |  D-S-G  | ignored |
  |- Cursor           ||           ||ignored  |  D-S-G  |  D-S-G  | ignored |
  |___________________||___________||_________|_________|_________|_________|


Key:

C    This value must be set with XCreateIC().




                             17





XIM Public Review Draft


D    This value may be set using XCreateIC().  If not set, a  default  is  pro-
     vided.

G    This value may be read using XGetICValues().

GN   This IC value may cause geometry negotiation when its  value  is  set  via
     XCreateIC() or XSetICValues().

GR   This value will be the response of the input method when any GN  value  is
     changed.

GS   This value will cause the geometry of the input method window to be set.

O    This value must be set once and only once. It need not be set at IC create
     time.

S    This value may be set with XSetICValues().

ignored
     The IC value is ignored by the input method for the given input style.


3.3.1.  Input Style

Argument XNInputStyle specifies the input style to be used. The value  of  this
argument must be one of the values returned by function XGetIMValues with argu-
ment XNQueryInputStyle in the supported_styles list, otherwise  error  BadStyle
will be raised.

This argument must be set at creation time and cannot be changed.

3.3.2.  Client Window

Argument XNClientWindow specifies to input method the client  window  in  which
the  input  method  can display data or create subwindows.  Geometry values for
input method areas are given with respect to the client window.  Dynamic change
of  client  window is not supported.  This argument may be set only once.  This
argument should be set before any input is done using this input context. If it
is not set the input method may not operate correctly.

If an attempt is made to set this value a second time  with  XSetICValues,  the
string  "XNClientWindow" will be returned by XSetICValues and the client window
shall not be changed.

If the client window is not a valid window id on the display  attached  to  the
input  method  this  argument can generate a BadWindow error when this value is
used by the input method.

3.3.3.  Focus Window

Argument XNFocusWindow specifies the focus window.  The primary purpose of  the
XNFocusWindow  is  to identify the window which will receive the key event when
input is composed.  In addition, the input method may possibly affect the focus
window:  select  events  on  it, send events to it, modify its properties, grab



                             18





XIM Public Review Draft


keyboard within that window.

The value associated to the argument must be of type Window.  If the focus win-
dow  is  not a valid window id on the display attached to the input method this
argument can generate a BadWindow error when this value is used  by  the  input
method.

When this slot is left unspecified, input method will default focus  window  to
client window.

3.3.4.  Resource Name and Class

Arguments XNResourceName and XNResourceClass are  strings  that  represent  the
full  name  and  class hierarchy used by the client to obtain resources for the
client window. These values should be used as prefixes for name and class  when
looking  up  resources  that may vary according to the IC.  If these values are
not set, the resources will not be fully specified.

It is not intended that values which  can  be  set  as  IC  values  be  set  as
resources.

3.3.5.  Geometry Callback

The argument  XNGeometryCallback  is  a  structure  of  type  XIMCallback  (see
PreEdit/Status Callbacks).

The argument XNGeometryCallback specifies the geometry callback which a  client
can  set.   This  callback  is  not required for correct operation of either an
input method or a client. It can be set for a client whose user interface  pol-
icy permits an input method to request the dynamic change of that input methods
window.  An input method that does dynamic  change  will  need  to  filter  any
events that it uses to initiate the change.

3.3.6.  Filter Events

The argument XNFilterEvents will return the event mask that  an  input  methods
needs  to  have  selected for.  The client is expected to augment its own event
mask for the client window with this one.

This argument is read-only.  It is set by the input method at create  time  and
is never changed.

The type of this argument is unsigned long. Setting this value  will  cause  an
error.

3.3.7.  PreEdit and Status Attributes

Arguments XNPreeditAttributes and XNStatusAttributes specify  to  input  method
the  attributes  to  be  used  for the PreEdit and Status areas, if any.  Those
attributes are passed to XSetICValues or  XGetICValues  as  a  nested  variable
length  list.   The names to be used in such lists are as described in the next
subsection.





                             19





XIM Public Review Draft


3.3.7.1.  Area

The value of the argument XNArea must be a pointer to a structure of type XRec-
tangle.  The interpretation of argument XNArea is dependent on the input method
style set in the IC.

If the input method style is XIMPreEditPosition, XNArea specifies the  clipping
region  within  which preediting will take place.  If the focus window has been
set the coordinates are assumed to be relative to the  focus  window.   If  the
focus window has not been set the coordinates are assumed to be relative to the
client window.  If neither has been set, the results are undefined.  If  XNArea
is  not  specified  the  input  method  will default the clipping region to the
geometry of the XNFocusWindow.  If the area specified is NULL  or  invalid  the
results are undefined.

If the input style is XIMPreEditArea or  XIMStatusArea,  XNArea  specifies  the
geometry  provided by the client to the input method.  The input method may use
this area to display its data, either PreEdit or Status depending on  the  area
designated.  The input method may create a window as a child of the client win-
dow with dimensions that fit the XNArea.  The coordinates are relative  to  the
client  window.   If  the  client window has not been set yet, the input method
should save these values and apply them when the  client  window  is  set.   If
XNArea  is  not  specified, is set to NULL or is invalid, the results are unde-
fined.


3.3.7.2.  Area Needed

When set, argument XNAreaNeeded specifies the geometry suggested by the  client
for this area (PreEdit or Status).  The value associated with the argument must
be a pointer to a structure of type XRectangle.  The x, y values are not  used.
Non-zero  values for width or height are constraints that the client wishes the
input method to respect.

When read, argument XNAreaNeeded specifies the preferred  geometry  desired  by
the input method for the area.

This argument is only valid if the input style  is  XIMPreEditArea  or  XIMSta-
tusArea.   It is used for geometry negotiation between the client and the input
method and has no other effect upon the input method (refer to Geometry Manage-
ment.)


3.3.7.3.  Spot Location

Argument XNSpotLocation specifies  to  input  method  the  coordinates  of  the
"spot",  to  be  used  by  an  input  method executing with XNInputStyle set to
XIMPreEditPosition.  When specified to any input method other than NeedPosition
this slot is ignored.

The x coordinate specifies the position  where  the  next  character  would  be
inserted.   The  y  coordinate  is the position of the baseline used by current
text line in the focus window.  The x and y coordinates  are  relative  to  the
focus  window  if it has been set, else they are relative to the client window.



                             20





XIM Public Review Draft


If neither focus window nor client window has been set the  results  are  unde-
fined.

The value of the argument is a pointer to a structure of type XPoint.

3.3.7.4.  Colormap

Two arguments can be used to indicate what colormap the input method should use
to  allocate  colors:  one  as a colormap XID, the other as a standard colormap
name.  Argument XNColormap is used to specify a colormap id.  Argument value is
of  type  Colormap.   This  argument  may generate a BadColormap error when the
colormap is used by the input method.  Argument XNStdColormap is used to  indi-
cate the name of the standard colormap in which input method should to allocate
colors. Argument value is an Atom that should  be  a  valid  atom  for  calling
XGetStandardColormap.   This argument may generate BadAtom or BadColormap error
when it is used by the input method.

If colormap is left unspecified, it is defaulted to client window colormap.

3.3.7.5.  Foreground and background.

Arguments XNForeground and XNBackground specifies respectively  the  foreground
and  background  pixel.  Argument value is of type unsigned long.  It must be a
valid pixel in the input method colormap.  Error BadPixel is raised  when  this
argument  is  used  by  the  input method if pixel is not a valid pixel for the
colormap in use by the input method.

If these values are left unspecified, the default is determined  by  the  input
method.

3.3.7.6.  Background pixmap.

Argument XNBackgroundPixmap specifies a background pixmap to  be  used  as  the
background  of  the  window.  Slot  value must be of type Pixmap.  Can generate
error BadPixmap when this argument is used by the input method.

If this value is left unspecified, the  default  is  determined  by  the  input
method.