Chapter 3 Events and the Carbon Event Manager

1 Events

Carbon Event Manager所支持的事件有两个属性：

1.     Event Class，表示事件的类别，如鼠标消息：kEventClassMouse

2.     Event Kind，事件的具体类型，如鼠标按键按下消息：kEventMouseDown

kEventClassMouse和kEventMouseDown的定义如下：

KEventClassMouse = FOUR_CHAR_CODE('mous');

KEventMouseDown = 1;

 

一般情况下，使用EventTypeSpec结构来指定Event Class和Event Kind：

struct EventTypeSpec

{

       UInt32 eventClass;

       UInt32 eventKind;

};

比如，命令事件（类似WM_COMMAND）可以这么定义：

EventTypeSpec eventType = { kEventClassCommand,kEventProcessCommand };

 

2 Installing Events

调用InstallEventHandler函数“安装”事件处理函数，接收从Event Target发来的事件：

OSStatus InstallEventHandler( EventTargetRef target,

       EventHandlerUPP handlerProc,

       UInt32 numTypes,

       const EventTypeSpec* typeList,

       void* userData,

       EventHandlerRef* handlerRef );

1.     EventTargetRef target：指定Event Target，也就是事件所挂接的对象。可以用GetWindowEventTarget，GetMenuEventTarget，GetControlEventTarget等函数来获得Event Target，不能直接用窗口/菜单/控件本身

WindowRef window;

EventTargetRef target;

target = GetWindowEventTarget( window );

2.     EventHandlerUPP handlerProc：指定消息处理回调函数。UPP的意思是Universal Procedure Pointer，即统一过程指针，也就是指向回调函数的指针。可以用下面的代码来创建一个EventHandlerUPP对象：

EventHandlerUPP handlerUPP; // Universal procedure pointer

handlerUPP = NewEventHandlerUPP( MyEventHandler );

注意这里MyEventHandler才是回调函数，而handlerUPP指向它。

3.     UInt32 numTypes：事件处理的类型个数，可以一个事件处理函数对应多个事件（EventTypeSpec）

4.     Const EventTypeSpec *typeList：和前面对应，是一个数组，中有numTypes个EventTypeSpec，指定了numTypes个事件

5.     Void *userData：用户自定义的数据，最终会作为参数传入到事件处理函数中，一般会把Event Target所对应的对象（如Window）传入，如果不需要的话则NULL

6.     EventHandlerRef *handlerRef：返回一个对Event Handler对象的指针

3 Event Handler Prototypes

事件处理函数的原型如下：

pascal OSStatus routineName( EventHandlerCallRef nextHandler,

       EventRef theEvent,

       void* userData );

1.     EventHandlerCallRef nextHandler：在事件连接中的下一个事件处理对象，你有时候也许需要先调用其他的处理函数（如缺省的消息处理），然后在这之后再进行处理，可以调用CallNextEventHandler来事先调用下一个事件

2.     EventRef theEvent：事件对象的Ref，主要用来获得事件的Parameters

3.     Void *userData：之前在InstallEventHandler函数中传入的用户数据指针

4.     返回noErr表示没有错误，而返回eventNotHandledErr则表明使用系统缺省的消息处理（如同DefWindowProc API）

4 Event Parameters

事件本身会带很多参数。Mac OS X并不是在事件处理函数的参数里面传入这些参数，而是把这些参数绑定到事件对象本身，然后通过GetEventParameter来获得参数：

OSStatus GetEventParameter( EventRef inEvent,

       EventParamName inName,

       EventParamType inDesiredType,

       EventParamType * outActualType,

       UInt32 inBufferSize,

       UInt32 * outActualSize,

       void * outData);

1.     EventParamName inName，EventParamType inDesiredType：事件参数有着名字和类型，比如对kEventMouseDown事件来说，该事件有下面的参数：

Name

Type

Information

kEventParamMouseLocation

typeQDPoint

鼠标位置

kEventParamMouseButton

typeMouseButton

鼠标按键

kEventParamKeyModifiers

typeUInt32

键盘按键

kEventParamClickCount

typeUInt32

按键次数

 

2.     EventParamType *outActualType：返回实际的类型，大部分情况下直接添NULL即可

3.     Uint32 inBufferSize：缓冲区大小

4.     Uint32 *outActualSize：返回实际需要的缓冲区大小，可以添NULL

5.     Void *outData：缓冲区

5 A Sample

下面的事件处理函数负责处理kThisCommand/kThatCommand菜单项，分别作出不同处理：

#define kThisCommand 'this'

#define kThatCommand 'that'

 

pascal OSStatus MyEventHandler( EventHandlerCallRef handlerRef,

       EventRef event,

       void * userData )

{

       OSStatus result = eventNotHandledErr;

       HICommand command;

       GetEventParameter( event,

              kEventParamDirectObject,

              typeHICommand, NULL,

              sizeof (HICommand), NULL,

              &command );

       switch ( command.commandID )

       {

              case kThisCommand:

                     MyThisCommandHandler( (WindowRef)userData );

                     result = noErr;

                     break;

              case kThatCommand:

                     MyThatCommandHandler( (WindowRef)userData );

                     result = noErr;

                     break;

       }

 

       return result;

}