man/XtSetLanguageProc.man

   1 .\" Copyright 1993 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be
  12 .\" included in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .ds tk X Toolkit
  28 .ds xT X Toolkit Intrinsics \- C Language Interface
  29 .ds xI Intrinsics
  30 .ds xW X Toolkit Athena Widgets \- C Language Interface
  31 .ds xL Xlib \- C Language X Interface
  32 .ds xC Inter-Client Communication Conventions Manual
  33 .ds Rn 3
  34 .ds Vn 2.2
  35 .hw XtSet-Language-Proc wid-get
  36 .na
  37 .de Ds
  38 .nf
  39 .\\$1D \\$2 \\$1
  40 .ft CW
  41 .ps \\n(PS
  42 .\".if \\n(VS>=40 .vs \\n(VSu
  43 .\".if \\n(VS<=39 .vs \\n(VSp
  44 ..
  45 .de De
  46 .ce 0
  47 .if \\n(BD .DF
  48 .nr BD 0
  49 .in \\n(OIu
  50 .if \\n(TM .ls 2
  51 .sp \\n(DDu
  52 .fi
  53 ..
  54 .de IN          \" send an index entry to the stderr
  55 ..
  56 .de Pn
  57 .ie t \\$1\fB\^\\$2\^\fR\\$3
  58 .el \\$1\fI\^\\$2\^\fP\\$3
  59 ..
  60 .de ZN
  61 .ie t \fB\^\\$1\^\fR\\$2
  62 .el \fI\^\\$1\^\fP\\$2
  63 ..
  64 .ny0
  65 .TH XtSetLanguageProc __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  66 .SH NAME
  67 XtSetLanguageProc \- set the language procedure
  68 .SH SYNTAX
  69 .HP
  70 Widget XtSetLanguageProc(XtAppContext \fIapp_context\fP, XtLanguageProc
  71 \fIproc\fP, XtPointer \fIclient_data\fP);
  72 .SH ARGUMENTS
  73 .IP \fIapp_context\fP 1i
  74 Specifies the application context in which the language procedure
  75 is to be used, or NULL.
  76 .LP
  77 .IP \fIproc\fP 1i
  78 Specifies the language procedure, or NULL.
  79 .LP
  80 .IP \fIclient_data\fP 1i
  81 Specifies additional client data to be passed to the language procedure
  82 when it is called.
  83 .SH DESCRIPTION
  84 .ZN XtSetLanguageProc
  85 sets the language procedure that will be called from
  86 .ZN XtDisplayInitialize
  87 for all subsequent Displays initialized in the specified application
  88 context. If \fIapp_context\fP is NULL, the specified language procedure
  89 is registered in all application contexts created by the calling process,
  90 including any future application contexts that may be created. If
  91 \fIproc\fP is NULL a default language procedure is registered.
  92 .ZN XtSetLanguageProc
  93 returns the previously registered language procedure. If a language
  94 procedure has not yet been registered, the return value is unspecified
  95 but if this return value is used in a subsequent call to
  96 .ZN XtSetLanguageProc ,
  97 it will cause the default language procedure to be registered.
  98 .LP
  99 The default language procedure does the following:
 100 .IP \(bu 5
 101 Sets the locale according to the environment. On ANSI C-based systems
 102 this is done by calling
 103 .ZN setlocale (
 104 .ZN LC_ALL ,
 105 language ). If an error is encountered a warning message is issued with
 106 .ZN XtWarning .
 107 .IP \(bu 5
 108 Calls
 109 .ZN XSupportsLocale
 110 to verify that the current locale is supported. If the locale is not
 111 supported, a warning message is issued with
 112 .ZN XtWarning
 113 and the locale is set to ``C''.
 114 .IP \(bu 5
 115 Calls
 116 .ZN XSetLocaleModifiers
 117 specifying the empty string.
 118 .IP \(bu 5
 119 Returns the value of the current locale. On ANSI C-based systems this
 120 is the return value from a final call to
 121 .ZN setlocale (
 122 .ZN LC_ALL ,
 123 NULL ).
 124 .LP
 125 A client wishing to use this mechanism to establish locale can do so
 126 by calling
 127 .ZN XtSetLanguageProc
 128 prior to
 129 .ZN XtDisplayInitialize.
 130 .SH "SEE ALSO"
 131 .br
 132 \fI\*(xT\fP
 133 .br
 134 \fI\*(xL\fP