Back to index

im-sdk  12.3.91
InputContext.hh
Go to the documentation of this file.
00001 /*
00002 Copyright 1990-2001 Sun Microsystems, Inc. All Rights Reserved.
00003 
00004 Permission is hereby granted, free of charge, to any person obtaining a
00005 copy of this software and associated documentation files (the
00006 "Software"), to deal in the Software without restriction, including
00007 without limitation the rights to use, copy, modify, merge, publish,
00008 distribute, sublicense, and/or sell copies of the Software, and to
00009 permit persons to whom the Software is furnished to do so, subject to
00010 the following conditions: The above copyright notice and this
00011 permission notice shall be included in all copies or substantial
00012 portions of the Software.
00013 
00014 
00015 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
00016 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00017 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00018 IN NO EVENT SHALL THE OPEN GROUP OR SUN MICROSYSTEMS, INC. BE LIABLE
00019 FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
00020 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
00021 THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE EVEN IF
00022 ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH DAMAGES.
00023 
00024 
00025 Except as contained in this notice, the names of The Open Group and/or
00026 Sun Microsystems, Inc. shall not be used in advertising or otherwise to
00027 promote the sale, use or other dealings in this Software without prior
00028 written authorization from The Open Group and/or Sun Microsystems,
00029 Inc., as applicable.
00030 
00031 
00032 X Window System is a trademark of The Open Group
00033 
00034 OSF/1, OSF/Motif and Motif are registered trademarks, and OSF, the OSF
00035 logo, LBX, X Window System, and Xinerama are trademarks of the Open
00036 Group. All other trademarks and registered trademarks mentioned herein
00037 are the property of their respective owners. No right, title or
00038 interest in or to any trademark, service mark, logo or trade name of
00039 Sun Microsystems, Inc. or its licensors is granted.
00040 
00041 */
00042 #ifndef _inputcontext_hh
00043 #define _inputcontext_hh
00044 
00045 #include "IMList.hh"
00046 #include "IMArg.h"
00047 #include "IMProtocolStruct.h"
00048 
00049 class CompoundString;
00050 struct IMPreeditStruct;
00051 struct IMStatusStruct;
00052 struct IMLookupStruct;
00053 
00054 class InputContext {
00055  public:
00056   InputContext() {};
00057   virtual ~InputContext() {};
00058 
00059   // query an ICValue of InputContext
00060   virtual const CompoundString& getUser() const =0;
00061   virtual const CompoundString& getLocaleName() const =0;
00062   virtual const CompoundString& getEngineName() const =0;
00063 
00064   // CLIENT DESCRIPTOR
00065   virtual const CompoundString& getApplicationName() const =0;
00066   virtual const CompoundString& getOSName() const=0;
00067   virtual const CompoundString& getOSArch() const=0;
00068   virtual const CompoundString& getOSVersion() const=0;
00069   // Client Display Info
00070   virtual const CompoundString& getXDisplayString() const=0;
00071   virtual const CompoundString& getXServerVendor() const=0;
00072 
00073   virtual int commit_string(IMText *text)=0;
00074   virtual int forward_event(IMKeyEventStruct *event)=0;
00075 
00076   virtual int preedit_start(IMPreeditStruct *preedit)=0;
00077   virtual int preedit_draw(IMPreeditStruct *preedit)=0;
00078   virtual int preedit_caret(IMPreeditStruct *preedit)=0;
00079   virtual int preedit_done(IMPreeditStruct *preedit)=0;
00080 
00081   virtual int status_start(IMStatusStruct *status)=0;
00082   virtual int status_draw(IMStatusStruct *status)=0;
00083   virtual int status_done(IMStatusStruct *status)=0;
00084 
00085   virtual int lookup_start(IMLookupStruct *lookup)=0;
00086   virtual int lookup_draw(IMLookupStruct *lookup)=0;
00087   // virtual int lookup_process(IMLookupStruct *lookup)=0;
00088   virtual int lookup_done(IMLookupStruct *lookup)=0;
00089 
00090   virtual int auxiliary_start(IMAuxStruct *auxiliary)=0;
00091   virtual int auxiliary_draw(IMAuxStruct *auxiliary)=0;
00092   virtual int auxiliary_done(IMAuxStruct *auxiliary)=0;
00093 
00094   virtual int conversion_start()=0;
00095   virtual int conversion_end()=0;
00096 
00097   void set_icvalues(IMArg *args, int n);
00098   void get_icvalues(IMArg *args, int n) const;
00099 
00100  private:
00101   IMList<char> arg_list;
00102 };
00103 
00104 #endif