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