dlls/winemac.drv/cocoa_cursorclipping.h

   1 /*
   2  * MACDRV CGEventTap-based cursor clipping class declaration
   3  *
   4  * Copyright 2011, 2012, 2013 Ken Thomases for CodeWeavers Inc.
   5  * Copyright 2021 Tim Clem for CodeWeavers Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  20  */
  21
  22 #import <AppKit/AppKit.h>
  23
  24
  25 @protocol WineClipCursorHandler <NSObject>
  26
  27 @property (readonly, nonatomic) BOOL clippingCursor;
  28 @property (readonly, nonatomic) CGRect cursorClipRect;
  29
  30     - (BOOL) startClippingCursor:(CGRect)rect;
  31     - (BOOL) stopClippingCursor;
  32
  33     - (void) clipCursorLocation:(CGPoint*)location;
  34
  35     - (void) setRetinaMode:(int)mode;
  36
  37     @optional
  38     /* If provided, should reposition the cursor as needed given the current
  39      * clipping rect. If not provided, the location will be clipped by
  40      * -clipCursorLocation, and the cursor will be warped normally.
  41      */
  42     - (BOOL) setCursorPosition:(CGPoint)pos;
  43
  44 @end
  45
  46
  47 @interface WineEventTapClipCursorHandler : NSObject <WineClipCursorHandler>
  48 {
  49     BOOL clippingCursor;
  50     CGRect cursorClipRect;
  51     CFMachPortRef cursorClippingEventTap;
  52     NSMutableArray* warpRecords;
  53     CGPoint synthesizedLocation;
  54     NSTimeInterval lastEventTapEventTime;
  55 }
  56
  57 @end
  58
  59
  60 @interface WineConfinementClipCursorHandler : NSObject <WineClipCursorHandler>
  61 {
  62     BOOL clippingCursor;
  63     CGRect cursorClipRect;
  64     /* The number of the window that "owns" the clipping (i.e., the one with a
  65      * mouseConfinementRect set). Using this rather than a WineWindow* to avoid
  66      * tricky retain situations. */
  67     NSInteger clippingWindowNumber;
  68 }
  69
  70     /* Returns true if the API in use by this handler is available. */
  71     + (BOOL) isAvailable;
  72
  73 @end