include/wx/osx/cocoa/private.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/cocoa/private.h
   3 // Purpose:     Private declarations: as this header is only included by
   4 //              wxWidgets itself, it may contain identifiers which don't start
   5 //              with "wx".
   6 // Author:      Stefan Csomor
   7 // Modified by:
   8 // Created:     1998-01-01
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) Stefan Csomor
  11 // Licence:     wxWindows licence
  12 /////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_PRIVATE_COCOA_H_
  15 #define _WX_PRIVATE_COCOA_H_
  16
  17 #include <ApplicationServices/ApplicationServices.h>
  18
  19 #ifdef __OBJC__
  20     #import <Cocoa/Cocoa.h>
  21 #endif
  22
  23 #if MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_5
  24 // available in 10.4 but not in the headers
  25 enum {
  26     kEventMouseScroll             = 11
  27 };
  28 #endif
  29 //
  30 // shared between Cocoa and Carbon
  31 //
  32
  33 // bring in theming types without pulling in the headers
  34
  35 #if wxUSE_GUI
  36 typedef SInt16 ThemeBrush;
  37 CGColorRef WXDLLIMPEXP_CORE wxMacCreateCGColorFromHITheme( ThemeBrush brush ) ;
  38 OSStatus WXDLLIMPEXP_CORE wxMacDrawCGImage(
  39                                CGContextRef    inContext,
  40                                const CGRect *  inBounds,
  41                                CGImageRef      inImage) ;
  42 WX_NSImage WXDLLIMPEXP_CORE wxOSXGetNSImageFromCGImage( CGImageRef image );
  43 CGImageRef WXDLLIMPEXP_CORE wxOSXCreateCGImageFromNSImage( WX_NSImage nsimage );
  44 wxBitmap WXDLLIMPEXP_CORE wxOSXCreateSystemBitmap(const wxString& id, const wxString &client, const wxSize& size);
  45
  46 class WXDLLIMPEXP_FWD_CORE wxDialog;
  47
  48 class WXDLLIMPEXP_CORE wxWidgetCocoaImpl : public wxWidgetImpl
  49 {
  50 public :
  51     wxWidgetCocoaImpl( wxWindowMac* peer , WXWidget w, bool isRootControl = false, bool isUserPane = false ) ;
  52     wxWidgetCocoaImpl() ;
  53     ~wxWidgetCocoaImpl();
  54
  55     void Init();
  56
  57     virtual bool        IsVisible() const ;
  58     virtual void        SetVisibility(bool);
  59
  60     // we provide a static function which can be reused from
  61     // wxNonOwnedWindowCocoaImpl too
  62     static bool ShowViewOrWindowWithEffect(wxWindow *win,
  63                                            bool show,
  64                                            wxShowEffect effect,
  65                                            unsigned timeout);
  66
  67     virtual bool ShowWithEffect(bool show,
  68                                 wxShowEffect effect,
  69                                 unsigned timeout);
  70
  71     virtual void        Raise();
  72
  73     virtual void        Lower();
  74
  75     virtual void        ScrollRect( const wxRect *rect, int dx, int dy );
  76
  77     virtual WXWidget    GetWXWidget() const { return m_osxView; }
  78
  79     virtual void        SetBackgroundColour(const wxColour&);
  80     virtual bool        SetBackgroundStyle(wxBackgroundStyle style);
  81
  82     virtual void        GetContentArea( int &left , int &top , int &width , int &height ) const;
  83     virtual void        Move(int x, int y, int width, int height);
  84     virtual void        GetPosition( int &x, int &y ) const;
  85     virtual void        GetSize( int &width, int &height ) const;
  86     virtual void        SetControlSize( wxWindowVariant variant );
  87
  88     virtual void        SetNeedsDisplay( const wxRect* where = NULL );
  89     virtual bool        GetNeedsDisplay() const;
  90
  91     virtual bool        CanFocus() const;
  92     // return true if successful
  93     virtual bool        SetFocus();
  94     virtual bool        HasFocus() const;
  95
  96     void                RemoveFromParent();
  97     void                Embed( wxWidgetImpl *parent );
  98
  99     void                SetDefaultButton( bool isDefault );
 100     void                PerformClick();
 101     virtual void        SetLabel(const wxString& title, wxFontEncoding encoding);
 102
 103     void                SetCursor( const wxCursor & cursor );
 104     void                CaptureMouse();
 105     void                ReleaseMouse();
 106
 107     wxInt32             GetValue() const;
 108     void                SetValue( wxInt32 v );
 109     wxBitmap            GetBitmap() const;
 110     void                SetBitmap( const wxBitmap& bitmap );
 111     void                SetBitmapPosition( wxDirection dir );
 112     void                SetupTabs( const wxNotebook &notebook );
 113     void                GetBestRect( wxRect *r ) const;
 114     bool                IsEnabled() const;
 115     void                Enable( bool enable );
 116     bool                ButtonClickDidStateChange() { return true ;}
 117     void                SetMinimum( wxInt32 v );
 118     void                SetMaximum( wxInt32 v );
 119     wxInt32             GetMinimum() const;
 120     wxInt32             GetMaximum() const;
 121     void                PulseGauge();
 122     void                SetScrollThumb( wxInt32 value, wxInt32 thumbSize );
 123
 124     void                SetFont( const wxFont & font , const wxColour& foreground , long windowStyle, bool ignoreBlack = true );
 125     void                SetToolTip( wxToolTip* tooltip );
 126
 127     void                InstallEventHandler( WXWidget control = NULL );
 128
 129     virtual bool        DoHandleMouseEvent(NSEvent *event);
 130     virtual bool        DoHandleKeyEvent(NSEvent *event);
 131     virtual bool        DoHandleCharEvent(NSEvent *event, NSString *text);
 132     virtual void        DoNotifyFocusEvent(bool receivedFocus, wxWidgetImpl* otherWindow);
 133
 134     virtual void        SetupKeyEvent(wxKeyEvent &wxevent, NSEvent * nsEvent, NSString* charString = NULL);
 135     virtual void        SetupMouseEvent(wxMouseEvent &wxevent, NSEvent * nsEvent);
 136
 137
 138     void                SetFlipped(bool flipped);
 139     virtual bool        IsFlipped() const { return m_isFlipped; }
 140
 141     // cocoa thunk connected calls
 142
 143     virtual unsigned int        draggingEntered(void* sender, WXWidget slf, void* _cmd);
 144     virtual void                draggingExited(void* sender, WXWidget slf, void* _cmd);
 145     virtual unsigned int        draggingUpdated(void* sender, WXWidget slf, void* _cmd);
 146     virtual bool                performDragOperation(void* sender, WXWidget slf, void* _cmd);
 147     virtual void                mouseEvent(WX_NSEvent event, WXWidget slf, void* _cmd);
 148     virtual void                keyEvent(WX_NSEvent event, WXWidget slf, void* _cmd);
 149     virtual void                insertText(NSString* text, WXWidget slf, void* _cmd);
 150     virtual bool                performKeyEquivalent(WX_NSEvent event, WXWidget slf, void* _cmd);
 151     virtual bool                acceptsFirstResponder(WXWidget slf, void* _cmd);
 152     virtual bool                becomeFirstResponder(WXWidget slf, void* _cmd);
 153     virtual bool                resignFirstResponder(WXWidget slf, void* _cmd);
 154     virtual void                resetCursorRects(WXWidget slf, void* _cmd);
 155     virtual bool                isFlipped(WXWidget slf, void* _cmd);
 156     virtual void                drawRect(void* rect, WXWidget slf, void* _cmd);
 157
 158     virtual void                controlAction(WXWidget slf, void* _cmd, void* sender);
 159     virtual void                controlDoubleAction(WXWidget slf, void* _cmd, void *sender);
 160
 161     // for wxTextCtrl-derived classes, put here since they don't all derive
 162     // from the same pimpl class.
 163     virtual void                controlTextDidChange();
 164
 165 protected:
 166     WXWidget m_osxView;
 167     NSEvent* m_lastKeyDownEvent;
 168     bool m_isFlipped;
 169     // if it the control has an editor, that editor will already send some
 170     // events, don't resend them
 171     bool m_hasEditor;
 172
 173     DECLARE_DYNAMIC_CLASS_NO_COPY(wxWidgetCocoaImpl)
 174 };
 175
 176 DECLARE_WXCOCOA_OBJC_CLASS( wxNSWindow );
 177
 178 class wxNonOwnedWindowCocoaImpl : public wxNonOwnedWindowImpl
 179 {
 180 public :
 181     wxNonOwnedWindowCocoaImpl( wxNonOwnedWindow* nonownedwnd) ;
 182     wxNonOwnedWindowCocoaImpl();
 183
 184     virtual ~wxNonOwnedWindowCocoaImpl();
 185
 186     virtual void WillBeDestroyed() ;
 187     void Create( wxWindow* parent, const wxPoint& pos, const wxSize& size,
 188     long style, long extraStyle, const wxString& name ) ;
 189     void Create( wxWindow* parent, WXWindow nativeWindow );
 190
 191     WXWindow GetWXWindow() const;
 192     void Raise();
 193     void Lower();
 194     bool Show(bool show);
 195
 196     virtual bool ShowWithEffect(bool show,
 197                                 wxShowEffect effect,
 198                                 unsigned timeout);
 199
 200     void Update();
 201     bool SetTransparent(wxByte alpha);
 202     bool SetBackgroundColour(const wxColour& col );
 203     void SetExtraStyle( long exStyle );
 204     void SetWindowStyleFlag( long style );
 205     bool SetBackgroundStyle(wxBackgroundStyle style);
 206     bool CanSetTransparent();
 207
 208     void MoveWindow(int x, int y, int width, int height);
 209     void GetPosition( int &x, int &y ) const;
 210     void GetSize( int &width, int &height ) const;
 211
 212     void GetContentArea( int &left , int &top , int &width , int &height ) const;
 213     bool SetShape(const wxRegion& region);
 214
 215     virtual void SetTitle( const wxString& title, wxFontEncoding encoding ) ;
 216
 217     virtual bool IsMaximized() const;
 218
 219     virtual bool IsIconized() const;
 220
 221     virtual void Iconize( bool iconize );
 222
 223     virtual void Maximize(bool maximize);
 224
 225     virtual bool IsFullScreen() const;
 226
 227     virtual bool ShowFullScreen(bool show, long style);
 228
 229     virtual void ShowWithoutActivating();
 230
 231     virtual void RequestUserAttention(int flags);
 232
 233     virtual void ScreenToWindow( int *x, int *y );
 234
 235     virtual void WindowToScreen( int *x, int *y );
 236
 237     virtual bool IsActive();
 238
 239     virtual void SetModified(bool modified);
 240     virtual bool IsModified() const;
 241
 242     wxNonOwnedWindow*   GetWXPeer() { return m_wxPeer; }
 243
 244     CGWindowLevel   GetWindowLevel() const { return m_macWindowLevel; }
 245     void            RestoreWindowLevel();
 246 protected :
 247     CGWindowLevel   m_macWindowLevel;
 248     WXWindow        m_macWindow;
 249     void *          m_macFullScreenData ;
 250     DECLARE_DYNAMIC_CLASS_NO_COPY(wxNonOwnedWindowCocoaImpl)
 251 };
 252
 253 #ifdef __OBJC__
 254
 255     WXDLLIMPEXP_CORE NSScreen* wxOSXGetMenuScreen();
 256     WXDLLIMPEXP_CORE NSRect wxToNSRect( NSView* parent, const wxRect& r );
 257     WXDLLIMPEXP_CORE wxRect wxFromNSRect( NSView* parent, const NSRect& rect );
 258     WXDLLIMPEXP_CORE NSPoint wxToNSPoint( NSView* parent, const wxPoint& p );
 259     WXDLLIMPEXP_CORE wxPoint wxFromNSPoint( NSView* parent, const NSPoint& p );
 260
 261     NSRect WXDLLIMPEXP_CORE wxOSXGetFrameForControl( wxWindowMac* window , const wxPoint& pos , const wxSize &size ,
 262         bool adjustForOrigin = true );
 263
 264     // used for many wxControls
 265
 266     @interface wxNSButton : NSButton
 267     {
 268         NSTrackingRectTag rectTag;
 269     }
 270
 271     @end
 272
 273     @interface wxNSBox : NSBox
 274     {
 275     }
 276
 277     @end
 278
 279     @interface wxNSTextFieldEditor : NSTextView
 280     {
 281         NSEvent* lastKeyDownEvent;
 282     }
 283
 284     @end
 285
 286     @interface wxNSTextField : NSTextField wxOSX_10_6_AND_LATER(<NSTextFieldDelegate>)
 287     {
 288         wxNSTextFieldEditor* fieldEditor;
 289     }
 290
 291     - (wxNSTextFieldEditor*) fieldEditor;
 292     - (void) setFieldEditor:(wxNSTextFieldEditor*) fieldEditor;
 293
 294     @end
 295
 296     @interface wxNSSecureTextField : NSSecureTextField wxOSX_10_6_AND_LATER(<NSTextFieldDelegate>)
 297     {
 298     }
 299
 300     @end
 301
 302
 303     @interface wxNSTextView : NSTextView wxOSX_10_6_AND_LATER(<NSTextViewDelegate>)
 304     {
 305     }
 306
 307     - (void)textDidChange:(NSNotification *)aNotification;
 308
 309     @end
 310
 311     @interface wxNSMenu : NSMenu
 312     {
 313        wxMenuImpl* impl;
 314     }
 315
 316     - (void) setImplementation:(wxMenuImpl*) item;
 317     - (wxMenuImpl*) implementation;
 318
 319     @end
 320
 321     @interface wxNSMenuItem : NSMenuItem
 322     {
 323        wxMenuItemImpl* impl;
 324     }
 325
 326     - (void) setImplementation:(wxMenuItemImpl*) item;
 327     - (wxMenuItemImpl*) implementation;
 328
 329     - (void)clickedAction:(id)sender;
 330     - (BOOL)validateMenuItem:(NSMenuItem *)menuItem;
 331
 332     @end
 333
 334     void WXDLLIMPEXP_CORE wxOSXCocoaClassAddWXMethods(Class c);
 335
 336     /*
 337     We need this for ShowModal, as the sheet just disables the parent window and
 338     returns control to the app, whereas we don't want to return from ShowModal
 339     until the sheet has been dismissed.
 340     */
 341     @interface ModalDialogDelegate : NSObject
 342     {
 343         BOOL sheetFinished;
 344         int resultCode;
 345         wxDialog* impl;
 346     }
 347
 348     - (void)setImplementation: (wxDialog *)dialog;
 349     - (BOOL)finished;
 350     - (int)code;
 351     - (void)waitForSheetToFinish;
 352     - (void)sheetDidEnd:(NSWindow *)sheet returnCode:(int)returnCode contextInfo:(void *)contextInfo;
 353     @end
 354
 355     WXEXPORT @interface wxNSAppController : NSObject wxOSX_10_6_AND_LATER(<NSApplicationDelegate>)
 356     {
 357     }
 358
 359     @end
 360
 361 #endif // __OBJC__
 362
 363 // NSCursor
 364
 365 WX_NSCursor wxMacCocoaCreateStockCursor( int cursor_type );
 366 WX_NSCursor  wxMacCocoaCreateCursorFromCGImage( CGImageRef cgImageRef, float hotSpotX, float hotSpotY );
 367 void  wxMacCocoaSetCursor( WX_NSCursor cursor );
 368 void  wxMacCocoaHideCursor();
 369 void  wxMacCocoaShowCursor();
 370
 371 typedef struct tagClassicCursor
 372 {
 373     wxUint16 bits[16];
 374     wxUint16 mask[16];
 375     wxInt16 hotspot[2];
 376 }ClassicCursor;
 377
 378 const short kwxCursorBullseye = 0;
 379 const short kwxCursorBlank = 1;
 380 const short kwxCursorPencil = 2;
 381 const short kwxCursorMagnifier = 3;
 382 const short kwxCursorNoEntry = 4;
 383 const short kwxCursorPaintBrush = 5;
 384 const short kwxCursorPointRight = 6;
 385 const short kwxCursorPointLeft = 7;
 386 const short kwxCursorQuestionArrow = 8;
 387 const short kwxCursorRightArrow = 9;
 388 const short kwxCursorSizeNS = 10;
 389 const short kwxCursorSize = 11;
 390 const short kwxCursorSizeNESW = 12;
 391 const short kwxCursorSizeNWSE = 13;
 392 const short kwxCursorRoller = 14;
 393 const short kwxCursorWatch = 15;
 394 const short kwxCursorLast = kwxCursorWatch;
 395
 396 // exposing our fallback cursor map
 397
 398 extern ClassicCursor gMacCursors[];
 399
 400 #endif
 401
 402 #endif
 403     // _WX_PRIVATE_COCOA_H_
 404