TextServices.h

Go to the documentation of this file.

 
#ifndef __TEXTSERVICES__
#define __TEXTSERVICES__
 
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __EVENTS__
#include <Events.h>
#endif
 
#ifndef __MENUS__
#include <Menus.h>
#endif
 
#ifndef __AEDATAMODEL__
#include <AEDataModel.h>
#endif
 
#ifndef __AEREGISTRY__
#include <AERegistry.h>
#endif
 
#ifndef __AEINTERACTION__
#include <AEInteraction.h>
#endif
 
#ifndef __COMPONENTS__
#include <Components.h>
#endif
 
#ifndef __CARBONEVENTS__
#include <CarbonEvents.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
    enum
    {
        kTextService = FOUR_CHAR_CODE(
            'tsvc'), 
        kInputMethodService = FOUR_CHAR_CODE(
            'inpm'),         
        kTSMVersion = 0x0150 
    };
 
    enum
    {
        kUnicodeDocument = FOUR_CHAR_CODE(
            'udoc'), 
        kUnicodeTextService =
            FOUR_CHAR_CODE('utsv') 
    };
 
    enum
    {
        kUnknownLanguage = 0xFFFF,
        kUnknownScript = 0xFFFF,
        kNeutralScript = 0xFFFF
    };
 
    enum
    {
        bTakeActiveEvent = 15,                            
        bHandleAERecording = 16,                          
        bScriptMask = 0x00007F00,                         
        bLanguageMask = 0x000000FF,                       
        bScriptLanguageMask = bScriptMask + bLanguageMask 
    };
 
    enum
    {
        kIMJaTypingMethodProperty = FOUR_CHAR_CODE(
            'jtyp'),                                     
        kIMJaTypingMethodRoman = FOUR_CHAR_CODE('roma'), 
        kIMJaTypingMethodKana = FOUR_CHAR_CODE('kana')   
    };
 
    enum
    {
        kCMGetScriptLangSupport = 0x0001,   
        kCMInitiateTextService = 0x0002,    
        kCMTerminateTextService = 0x0003,   
        kCMActivateTextService = 0x0004,    
        kCMDeactivateTextService = 0x0005,  
        kCMTextServiceEvent = 0x0006,       
        kCMGetTextServiceMenu = 0x0007,     
        kCMTextServiceMenuSelect = 0x0008,  
        kCMFixTextService = 0x0009,         
        kCMSetTextServiceCursor = 0x000A,   
        kCMHidePaletteWindows = 0x000B,     
        kCMGetTextServiceProperty = 0x000C, 
        kCMSetTextServiceProperty = 0x000D  
    };
 
    enum
    {
        kCMUCTextServiceEvent = 0x000E 
    };
 
#define mGetScriptCode(cdRec) \
    ((ScriptCode)((cdRec.componentFlags & bScriptMask) >> 8))
#define mGetLanguageCode(cdRec) ((LangCode)cdRec.componentFlags & bLanguageMask)
 
    typedef struct OpaqueTSMDocumentID *TSMDocumentID;
    typedef OSType InterfaceTypeList[1];
 
    struct TextServiceInfo
    {
        Component fComponent;
        Str255 fItemName;
    };
    typedef struct TextServiceInfo TextServiceInfo;
    typedef TextServiceInfo *TextServiceInfoPtr;
    struct TextServiceList
    {
        short fTextServiceCount; 
        TextServiceInfo
            fServices[1]; 
    };
    typedef struct TextServiceList TextServiceList;
    typedef TextServiceList *TextServiceListPtr;
    typedef TextServiceListPtr *TextServiceListHandle;
    struct ScriptLanguageRecord
    {
        ScriptCode fScript;
        LangCode fLanguage;
    };
    typedef struct ScriptLanguageRecord ScriptLanguageRecord;
    struct ScriptLanguageSupport
    {
        short fScriptLanguageCount; 
        ScriptLanguageRecord
            fScriptLanguageArray[1]; 
    };
    typedef struct ScriptLanguageSupport ScriptLanguageSupport;
    typedef ScriptLanguageSupport *ScriptLanguageSupportPtr;
    typedef ScriptLanguageSupportPtr *ScriptLanguageSupportHandle;
    OSErr
    NewTSMDocument(short numOfInterface, InterfaceTypeList supportedInterfaceTypes,
                   TSMDocumentID *idocID, long refcon);
 
    OSErr
    DeleteTSMDocument(TSMDocumentID idocID);
 
    OSErr
    ActivateTSMDocument(TSMDocumentID idocID);
 
    OSErr
    DeactivateTSMDocument(TSMDocumentID idocID);
 
    OSErr
    FixTSMDocument(TSMDocumentID idocID);
 
    OSErr
    GetServiceList(short numOfInterface, OSType *supportedInterfaceTypes,
                   TextServiceListHandle *serviceInfo, long *seedValue);
 
    OSErr
    OpenTextService(TSMDocumentID idocID, Component aComponent,
                    ComponentInstance *aComponentInstance);
 
    OSErr
    CloseTextService(TSMDocumentID idocID, ComponentInstance aComponentInstance);
 
    OSErr
    SendAEFromTSMComponent(const AppleEvent *theAppleEvent, AppleEvent *reply,
                           AESendMode sendMode, AESendPriority sendPriority,
                           long timeOutInTicks, AEIdleUPP idleProc,
                           AEFilterUPP filterProc);
 
    OSStatus
    SendTextInputEvent(EventRef inEvent);
 
    OSErr
    SetDefaultInputMethod(Component ts, ScriptLanguageRecord *slRecordPtr);
 
    OSErr
    GetDefaultInputMethod(Component *ts, ScriptLanguageRecord *slRecordPtr);
 
    OSErr
    SetTextServiceLanguage(ScriptLanguageRecord *slRecordPtr);
 
    OSErr
    GetTextServiceLanguage(ScriptLanguageRecord *slRecordPtr);
 
    OSErr
    UseInputWindow(TSMDocumentID idocID, Boolean useWindow);
 
    OSStatus
    TSMSetInlineInputRegion(TSMDocumentID inTSMDocument, WindowRef inWindow,
                            RgnHandle inRegion);
 
#if CALL_NOT_IN_CARBON
    Boolean
    TSMEvent(EventRecord *event);
 
    Boolean
    TSMMenuSelect(long menuResult);
 
    Boolean
    SetTSMCursor(Point mousePos);
 
    OSErr
    NewServiceWindow(void *wStorage, const Rect *boundsRect, ConstStr255Param title,
                     Boolean visible, short theProc, WindowRef behind,
                     Boolean goAwayFlag, ComponentInstance ts, WindowRef *window);
 
    OSErr
    CloseServiceWindow(WindowRef window);
 
    OSErr
    GetFrontServiceWindow(WindowRef *window);
 
    short
    FindServiceWindow(Point thePoint, WindowRef *theWindow);
 
    OSErr
    NewCServiceWindow(void *wStorage, const Rect *boundsRect,
                      ConstStr255Param title, Boolean visible, short theProc,
                      WindowRef behind, Boolean goAwayFlag, ComponentInstance ts,
                      WindowRef *window);
 
    OSErr
    InitTSMAwareApplication(void);
 
    OSErr
    CloseTSMAwareApplication(void);
 
#endif 
    ComponentResult
    GetScriptLanguageSupport(ComponentInstance ts,
                             ScriptLanguageSupportHandle *scriptHdl);
 
    ComponentResult
    InitiateTextService(ComponentInstance ts);
 
    ComponentResult
    TerminateTextService(ComponentInstance ts);
 
    ComponentResult
    ActivateTextService(ComponentInstance ts);
 
    ComponentResult
    DeactivateTextService(ComponentInstance ts);
 
    ComponentResult
    GetTextServiceMenu(ComponentInstance ts, MenuRef *serviceMenu);
 
    ComponentResult
    TextServiceEventRef(ComponentInstance ts, EventRef event);
 
#if CALL_NOT_IN_CARBON
    ComponentResult
    TextServiceEvent(ComponentInstance ts, short numOfEvents, EventRecord *event);
 
    ComponentResult
    UCTextServiceEvent(ComponentInstance ts, short numOfEvents, EventRecord *event,
                       UniChar unicodeString[], UniCharCount unicodeStrLength);
 
    ComponentResult
    TextServiceMenuSelect(ComponentInstance ts, MenuRef serviceMenu, short item);
 
    ComponentResult
    SetTextServiceCursor(ComponentInstance ts, Point mousePos);
 
#endif 
    ComponentResult
    FixTextService(ComponentInstance ts);
 
    ComponentResult
    HidePaletteWindows(ComponentInstance ts);
 
    ComponentResult
    GetTextServiceProperty(ComponentInstance ts, OSType propertySelector,
                           SInt32 *result);
 
    ComponentResult
    SetTextServiceProperty(ComponentInstance ts, OSType propertySelector,
                           SInt32 value);
 
    TSMDocumentID
    TSMGetActiveDocument(void);
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif