// Author: David Elliott
// Modified by:
// Created: 2002/12/26
-// RCS-ID: $Id$
// Copyright: (c) 2002 David Elliott
-// Licence: wxWidgets licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/wxprec.h"
#include "wx/log.h"
#include "wx/window.h"
#include "wx/dc.h"
+ #include "wx/dcclient.h"
#include "wx/utils.h"
#endif //WX_PRECOMP
#include "wx/tooltip.h"
+#include "wx/cocoa/dc.h"
#include "wx/cocoa/autorelease.h"
#include "wx/cocoa/string.h"
#include "wx/cocoa/trackingrectmanager.h"
+#include "wx/cocoa/private/scrollview.h"
+#include "wx/osx/core/cfref.h"
+#include "wx/cocoa/ObjcRef.h"
+#import <Foundation/NSArray.h>
#import <Foundation/NSRunLoop.h>
#include "wx/cocoa/objc/NSView.h"
#import <AppKit/NSEvent.h>
#import <AppKit/NSScrollView.h>
+#import <AppKit/NSScroller.h>
#import <AppKit/NSColor.h>
#import <AppKit/NSClipView.h>
#import <Foundation/NSException.h>
#import <AppKit/NSApplication.h>
#import <AppKit/NSWindow.h>
+#import <AppKit/NSScreen.h>
// Turn this on to paint green over the dummy views for debugging
#undef WXCOCOA_FILL_DUMMY_VIEW
#import <AppKit/NSBezierPath.h>
#endif //def WXCOCOA_FILL_DUMMY_VIEW
+// STL list used by wxCocoaMouseMovedEventSynthesizer
+#include <list>
+
/* NSComparisonResult is typedef'd as an enum pre-Leopard but typedef'd as
* NSInteger post-Leopard. Pre-Leopard the Cocoa toolkit expects a function
* returning int and not NSComparisonResult. Post-Leopard the Cocoa toolkit
- (void)getRectsBeingDrawn:(const NSRect **)rects count:(int *)count;
@end
+// ========================================================================
+// Helper functions for converting to/from wxWidgets coordinates and a
+// specified NSView's coordinate system.
+// ========================================================================
NSPoint CocoaTransformNSViewBoundsToWx(NSView *nsview, NSPoint pointBounds)
{
wxCHECK_MSG(nsview, pointBounds, wxT("Need to have a Cocoa view to do translation"));
);
}
+// ============================================================================
+// Screen coordinate helpers
+// ============================================================================
+
+/*
+General observation about Cocoa screen coordinates:
+It is documented that the first object of the [NSScreen screens] array is the screen with the menubar.
+
+It is not documented (but true as far as I can tell) that (0,0) in Cocoa screen coordinates is always
+the BOTTOM-right corner of this screen. Recall that Cocoa uses cartesian coordinates so y-increase is up.
+
+It isn't clearly documented but visibleFrame returns a rectangle in screen coordinates, not a rectangle
+relative to that screen's frame. The only real way to test this is to configure two screens one atop
+the other such that the menubar screen is on top. The Dock at the bottom of the screen will then
+eat into the visibleFrame of screen 1 by incrementing it's y-origin. Thus if you arrange two
+1920x1200 screens top/bottom then screen 1 (the bottom screen) will have frame origin (0,-1200) and
+visibleFrame origin (0,-1149) which is exactly 51 pixels higher than the full frame origin.
+
+In wxCocoa, we somewhat arbitrarily declare that wx (0,0) is the TOP-left of screen 0's frame (the entire screen).
+However, this isn't entirely arbitrary because the Quartz Display Services (CGDisplay) uses this same scheme.
+This works out nicely because wxCocoa's wxDisplay is implemented using Quartz Display Services instead of NSScreen.
+*/
+
+namespace { // file namespace
+
+class wxCocoaPrivateScreenCoordinateTransformer
+{
+ wxDECLARE_NO_COPY_CLASS(wxCocoaPrivateScreenCoordinateTransformer);
+public:
+ wxCocoaPrivateScreenCoordinateTransformer();
+ ~wxCocoaPrivateScreenCoordinateTransformer();
+ wxPoint OriginInWxDisplayCoordinatesForRectInCocoaScreenCoordinates(NSRect windowFrame);
+ NSPoint OriginInCocoaScreenCoordinatesForRectInWxDisplayCoordinates(wxCoord x, wxCoord y, wxCoord width, wxCoord height, bool keepOriginVisible);
+
+protected:
+ NSScreen *m_screenZero;
+ NSRect m_screenZeroFrame;
+};
+
+// NOTE: This is intended to be a short-lived object. A future enhancment might
+// make it a global and reconfigure it upon some notification that the screen layout
+// has changed.
+inline wxCocoaPrivateScreenCoordinateTransformer::wxCocoaPrivateScreenCoordinateTransformer()
+{
+ NSArray *screens = [NSScreen screens];
+
+ [screens retain];
+
+ m_screenZero = nil;
+ if(screens != nil && [screens count] > 0)
+ m_screenZero = [[screens objectAtIndex:0] retain];
+
+ [screens release];
+
+ if(m_screenZero != nil)
+ m_screenZeroFrame = [m_screenZero frame];
+ else
+ {
+ wxLogWarning(wxT("Can't translate to/from wx screen coordinates and Cocoa screen coordinates"));
+ // Just blindly assume 1024x768 so that at least we can sort of flip things around into
+ // Cocoa coordinates.
+ // NOTE: Theoretically this case should never happen anyway.
+ m_screenZeroFrame = NSMakeRect(0,0,1024,768);
+ }
+}
+
+inline wxCocoaPrivateScreenCoordinateTransformer::~wxCocoaPrivateScreenCoordinateTransformer()
+{
+ [m_screenZero release];
+ m_screenZero = nil;
+}
+
+inline wxPoint wxCocoaPrivateScreenCoordinateTransformer::OriginInWxDisplayCoordinatesForRectInCocoaScreenCoordinates(NSRect windowFrame)
+{
+ // x and y are in wx screen coordinates which we're going to arbitrarily define such that
+ // (0,0) is the TOP-left of screen 0 (the one with the menubar)
+ // NOTE WELL: This means that (0,0) is _NOT_ an appropriate position for a window.
+
+ wxPoint theWxOrigin;
+
+ // Working in Cocoa's screen coordinates we must realize that the x coordinate we want is
+ // the distance between the left side (origin.x) of the window's frame and the left side of
+ // screen zero's frame.
+ theWxOrigin.x = windowFrame.origin.x - m_screenZeroFrame.origin.x;
+
+ // Working in Cocoa's screen coordinates we must realize that the y coordinate we want is
+ // actually the distance between the top-left of the screen zero frame and the top-left
+ // of the window's frame.
+
+ theWxOrigin.y = (m_screenZeroFrame.origin.y + m_screenZeroFrame.size.height) - (windowFrame.origin.y + windowFrame.size.height);
+
+ return theWxOrigin;
+}
+
+inline NSPoint wxCocoaPrivateScreenCoordinateTransformer::OriginInCocoaScreenCoordinatesForRectInWxDisplayCoordinates(wxCoord x, wxCoord y, wxCoord width, wxCoord height, bool keepOriginVisible)
+{
+ NSPoint theCocoaOrigin;
+
+ // The position is in wx screen coordinates which we're going to arbitrarily define such that
+ // (0,0) is the TOP-left of screen 0 (the one with the menubar)
+
+ // NOTE: The usable rectangle is smaller and hence we have the keepOriginVisible flag
+ // which will move the origin downward and/or left as necessary if the origin is
+ // inside the screen0 rectangle (i.e. x/y >= 0 in wx coordinates) and outside the
+ // visible frame (i.e. x/y < the top/left of the screen0 visible frame in wx coordinates)
+ // We don't munge origin coordinates < 0 because it actually is possible that the menubar is on
+ // the top of the bottom screen and thus that origin is completely valid!
+ if(keepOriginVisible && (m_screenZero != nil))
+ {
+ // Do al of this in wx coordinates because it's far simpler since we're dealing with top/left points
+ wxPoint visibleOrigin = OriginInWxDisplayCoordinatesForRectInCocoaScreenCoordinates([m_screenZero visibleFrame]);
+ if(x >= 0 && x < visibleOrigin.x)
+ x = visibleOrigin.x;
+ if(y >= 0 && y < visibleOrigin.y)
+ y = visibleOrigin.y;
+ }
+
+ // The x coordinate is simple as it's just relative to screen zero's frame
+ theCocoaOrigin.x = m_screenZeroFrame.origin.x + x;
+ // Working in Cocoa's coordinates think to start at the bottom of screen zero's frame and add
+ // the height of that rect which gives us the coordinate for the top of the visible rect. Now realize that
+ // the wx coordinates are flipped so if y is say 10 then we want to be 10 pixels down from that and thus
+ // we subtract y. But then we still need to take into account the size of the window which is h and subtract
+ // that to get the bottom-left origin of the rectangle.
+ theCocoaOrigin.y = m_screenZeroFrame.origin.y + m_screenZeroFrame.size.height - y - height;
+
+ return theCocoaOrigin;
+}
+
+} // namespace
+
+wxPoint wxWindowCocoa::OriginInWxDisplayCoordinatesForRectInCocoaScreenCoordinates(NSRect windowFrame)
+{
+ wxCocoaPrivateScreenCoordinateTransformer transformer;
+ return transformer.OriginInWxDisplayCoordinatesForRectInCocoaScreenCoordinates(windowFrame);
+}
+
+NSPoint wxWindowCocoa::OriginInCocoaScreenCoordinatesForRectInWxDisplayCoordinates(wxCoord x, wxCoord y, wxCoord width, wxCoord height, bool keepOriginVisible)
+{
+ wxCocoaPrivateScreenCoordinateTransformer transformer;
+ return transformer.OriginInCocoaScreenCoordinatesForRectInWxDisplayCoordinates(x,y,width,height,keepOriginVisible);
+}
+
// ========================================================================
// wxWindowCocoaHider
// ========================================================================
class wxWindowCocoaHider: protected wxCocoaNSView
{
- DECLARE_NO_COPY_CLASS(wxWindowCocoaHider)
+ wxDECLARE_NO_COPY_CLASS(wxWindowCocoaHider);
public:
wxWindowCocoaHider(wxWindow *owner);
virtual ~wxWindowCocoaHider();
wxWindowCocoaHider();
};
-// ========================================================================
-// wxWindowCocoaScrollView
-// ========================================================================
-class wxWindowCocoaScrollView: protected wxCocoaNSView
-{
- DECLARE_NO_COPY_CLASS(wxWindowCocoaScrollView)
-public:
- wxWindowCocoaScrollView(wxWindow *owner);
- virtual ~wxWindowCocoaScrollView();
- inline WX_NSScrollView GetNSScrollView() { return m_cocoaNSScrollView; }
- void ClientSizeToSize(int &width, int &height);
- void DoGetClientSize(int *x, int *y) const;
- void Encapsulate();
- void Unencapsulate();
-protected:
- wxWindowCocoa *m_owner;
- WX_NSScrollView m_cocoaNSScrollView;
- virtual void Cocoa_FrameChanged(void);
- virtual void Cocoa_synthesizeMouseMoved(void) {}
-private:
- wxWindowCocoaScrollView();
-};
-
// ========================================================================
// wxDummyNSView
// ========================================================================
// ========================================================================
// wxWindowCocoaHider
+// NOTE: This class and method of hiding predates setHidden: support in
+// the toolkit. The hack used here is to replace the view with a stand-in
+// that will be subject to the usual Cocoa resizing rules.
+// When possible (i.e. when running on 10.3 or higher) we make it hidden
+// mostly as an optimization so Cocoa doesn't have to consider it when
+// drawing or finding key views.
// ========================================================================
wxWindowCocoaHider::wxWindowCocoaHider(wxWindow *owner)
: m_owner(owner)
initWithFrame:[owner->GetNSViewForHiding() frame]];
[m_dummyNSView setAutoresizingMask: [owner->GetNSViewForHiding() autoresizingMask]];
AssociateNSView(m_dummyNSView);
+
+ if([m_dummyNSView respondsToSelector:@selector(setHidden:)])
+ [m_dummyNSView setHidden:YES];
}
wxWindowCocoaHider::~wxWindowCocoaHider()
}
#endif //def WXCOCOA_FILL_DUMMY_VIEW
+
+/*! @class WXManualScrollView
+ @abstract An NSScrollView subclass which implements wx scroll behaviour
+ @discussion
+ Overrides default behaviour of NSScrollView such that this class receives
+ the scroller action messages and allows the wxCocoaScrollView to act
+ on them accordingly. In particular, because the NSScrollView will not
+ receive action messages from the scroller, it will not adjust the
+ document view. This must be done manually using the ScrollWindow
+ method of wxWindow.
+ */
+@interface WXManualScrollView : NSScrollView
+{
+ /*! @field m_wxCocoaScrollView
+ */
+ wxWindowCocoaScrollView *m_wxCocoaScrollView;
+}
+
+// Override these to set up the target/action correctly
+- (void)setHorizontalScroller:(NSScroller *)aScroller;
+- (void)setVerticalScroller:(NSScroller *)aScroller;
+- (void)setHasHorizontalScroller:(BOOL)flag;
+- (void)setHasVerticalScroller:(BOOL)flag;
+
+// NOTE: _wx_ prefix means "private" method like _ that Apple (and only Apple) uses.
+- (wxWindowCocoaScrollView*)_wx_wxCocoaScrollView;
+- (void)_wx_setWxCocoaScrollView:(wxWindowCocoaScrollView*)theWxScrollView;
+
+/*! @method _wx_doScroller
+ @abstract Handles action messages from the scrollers
+ @discussion
+ Similar to Apple's _doScroller: method which is private and not documented.
+ We do not, however, call that method. Instead, we effectively override
+ it entirely. We don't override it by naming ourself the same thing because
+ the base class code may or may not call that method for other reasons we
+ simply cannot know about.
+ */
+- (void)_wx_doScroller:(id)sender;
+
+@end
+
+
+@implementation WXManualScrollView : NSScrollView
+
+static inline void WXManualScrollView_DoSetScrollerTargetAction(WXManualScrollView *self, NSScroller *aScroller)
+{
+ if(aScroller != NULL && [self _wx_wxCocoaScrollView] != NULL)
+ {
+ [aScroller setTarget:self];
+ [aScroller setAction:@selector(_wx_doScroller:)];
+ }
+}
+
+- (void)setHorizontalScroller:(NSScroller *)aScroller
+{
+ [super setHorizontalScroller:aScroller];
+ WXManualScrollView_DoSetScrollerTargetAction(self, aScroller);
+}
+
+- (void)setVerticalScroller:(NSScroller *)aScroller
+{
+ [super setVerticalScroller:aScroller];
+ WXManualScrollView_DoSetScrollerTargetAction(self, aScroller);
+}
+
+- (void)setHasHorizontalScroller:(BOOL)flag
+{
+ [super setHasHorizontalScroller:flag];
+ WXManualScrollView_DoSetScrollerTargetAction(self, [self horizontalScroller]);
+}
+
+- (void)setHasVerticalScroller:(BOOL)flag
+{
+ [super setHasVerticalScroller:flag];
+ WXManualScrollView_DoSetScrollerTargetAction(self, [self verticalScroller]);
+}
+
+- (wxWindowCocoaScrollView*)_wx_wxCocoaScrollView
+{ return m_wxCocoaScrollView; }
+
+- (void)_wx_setWxCocoaScrollView:(wxWindowCocoaScrollView*)theWxScrollView
+{
+ m_wxCocoaScrollView = theWxScrollView;
+ [self setHorizontalScroller:[self horizontalScroller]];
+ [self setVerticalScroller:[self verticalScroller]];
+}
+
+- (void)_wx_doScroller:(id)sender
+{
+ if(m_wxCocoaScrollView != NULL)
+ m_wxCocoaScrollView->_wx_doScroller(sender);
+ else
+ wxLogError(wxT("Unexpected action message received from NSScroller"));
+}
+
+- (void)reflectScrolledClipView:(NSClipView *)aClipView
+{
+ struct _ScrollerBackup
+ {
+ _ScrollerBackup(NSScroller *aScroller)
+ : m_scroller(aScroller)
+ , m_floatValue(aScroller!=nil?[aScroller floatValue]:0.0)
+ , m_knobProportion(aScroller!=nil?[aScroller knobProportion]:1.0)
+ , m_isEnabled(aScroller!=nil?[aScroller isEnabled]:false)
+ {
+ }
+ NSScroller *m_scroller;
+ CGFloat m_floatValue;
+ CGFloat m_knobProportion;
+ BOOL m_isEnabled;
+ ~_ScrollerBackup()
+ {
+ if(m_scroller != nil)
+ {
+ [m_scroller setFloatValue:m_floatValue knobProportion:m_knobProportion];
+ [m_scroller setEnabled:m_isEnabled];
+ }
+ }
+ private:
+ _ScrollerBackup();
+ _ScrollerBackup(_ScrollerBackup const&);
+ _ScrollerBackup& operator=(_ScrollerBackup const&);
+ };
+ _ScrollerBackup _horizontalBackup([self horizontalScroller]);
+ _ScrollerBackup _verticalBackup([self verticalScroller]);
+ // We MUST call super's implementation or else nothing seems to work right at all.
+ // However, we need our scrollers not to change values due to the document window
+ // moving so we cheat and save/restore their values across this call.
+ [super reflectScrolledClipView: aClipView];
+}
+
+@end
+WX_IMPLEMENT_GET_OBJC_CLASS(WXManualScrollView,NSScrollView)
+
// ========================================================================
// wxFlippedNSClipView
// ========================================================================
// ========================================================================
wxWindowCocoaScrollView::wxWindowCocoaScrollView(wxWindow *owner)
: m_owner(owner)
+, m_cocoaNSScrollView() // nil
+, m_scrollRange() // {0,0}
+, m_scrollThumb() // {0,0}
+, m_virtualOrigin(0,0)
{
wxAutoNSAutoreleasePool pool;
wxASSERT(owner);
wxASSERT(owner->GetNSView());
- m_cocoaNSScrollView = [[NSScrollView alloc]
+ m_isNativeView = ![owner->GetNSView() isKindOfClass:[WX_GET_OBJC_CLASS(WXNSView) class]];
+ m_cocoaNSScrollView = [(m_isNativeView?[NSScrollView alloc]:[WXManualScrollView alloc])
initWithFrame:[owner->GetNSView() frame]];
AssociateNSView(m_cocoaNSScrollView);
+ if(m_isNativeView)
+ {
+ /* Set a bezel border around the entire thing because it looks funny without it.
+ TODO: Be sure to undo any borders on the real view (if any) and apply them
+ to this view if necessary. Right now, there is no border support in wxCocoa
+ so this isn't an issue.
+ */
+ [m_cocoaNSScrollView setBorderType:NSBezelBorder];
+ }
+ else
+ {
+ [(WXManualScrollView*)m_cocoaNSScrollView _wx_setWxCocoaScrollView: this];
+ // Don't set a bezel because we might be creating a scroll view due to being
+ // the "target window" of a wxScrolledWindow. That is to say that the user
+ // has absolutely no intention of scrolling the clip view used by this
+ // NSScrollView.
+ }
/* Replace the default NSClipView with a flipped one. This ensures
scrolling is "pinned" to the top-left instead of bottom-right. */
[m_cocoaNSScrollView setContentView:flippedClip];
[flippedClip release];
- [m_cocoaNSScrollView setBackgroundColor: [NSColor windowBackgroundColor]];
- [m_cocoaNSScrollView setHasHorizontalScroller: YES];
- [m_cocoaNSScrollView setHasVerticalScroller: YES];
+ // In all cases we must encapsulate the real NSView properly
Encapsulate();
}
wxWindowCocoaScrollView::~wxWindowCocoaScrollView()
{
DisassociateNSView(m_cocoaNSScrollView);
+ if(!m_isNativeView)
+ {
+ [(WXManualScrollView*)m_cocoaNSScrollView _wx_setWxCocoaScrollView:NULL];
+ }
[m_cocoaNSScrollView release];
}
*y = (int)nssize.height;
}
+static inline void SetCocoaScroller(NSScroller *aScroller, int WXUNUSED(orientation), int position, int thumbSize, int range)
+{
+ wxCHECK_RET(aScroller != nil, wxT("Expected the NSScrollView to have a scroller"));
+
+ // NOTE: thumbSize is already ensured to be >= 1 and <= range by our caller
+ // unless range = 0 in which case we shouldn't have been be called.
+ wxCHECK_RET(range > 0, wxT("Internal wxCocoa bug: shouldn't have been called with 0 range"));
+
+ // Range of valid position values is from 0 to effectiveRange
+ // NOTE: if thumbSize == range then effectiveRange is 0.
+ // thumbSize is at least 1 which gives range from 0 to range - 1 inclusive
+ // which is exactly what we want.
+ int effectiveRange = range - thumbSize;
+
+ // knobProportion is hopefully easy to understand
+ // Note that thumbSize is already guaranteed >= 1 by our caller.
+ CGFloat const knobProportion = CGFloat(thumbSize)/CGFloat(range);
+
+ // NOTE: When effectiveRange is zero there really is no valid position
+ // We arbitrarily pick 0.0 which is the same as a scroller in the home position.
+ CGFloat const floatValue = (effectiveRange != 0)?CGFloat(position)/CGFloat(effectiveRange):0.0;
+
+ [aScroller setFloatValue:floatValue knobProportion: knobProportion];
+ // Make sure it's visibly working
+ [aScroller setEnabled:YES];
+}
+
+void wxWindowCocoaScrollView::SetScrollPos(wxOrientation orientation, int position)
+{
+ // NOTE: Rather than using only setFloatValue: (which we could do) we instead
+ // simply share the SetCocoaScroller call because all but the knobProportion
+ // calculations have to be done anyway.
+ if(orientation & wxHORIZONTAL)
+ {
+ NSScroller *aScroller = [m_cocoaNSScrollView horizontalScroller];
+ if(aScroller != nil)
+ SetCocoaScroller(aScroller, orientation, position, m_scrollThumb[0], m_scrollRange[0]);
+ }
+ if(orientation & wxVERTICAL)
+ {
+ NSScroller *aScroller = [m_cocoaNSScrollView verticalScroller];
+ if(aScroller != nil)
+ SetCocoaScroller(aScroller, orientation, position, m_scrollThumb[1], m_scrollRange[1]);
+ }
+}
+
+void wxWindowCocoaScrollView::SetScrollbar(int orientation, int position, int thumbSize, int range)
+{
+ // FIXME: API assumptions:
+ // 1. If the user wants to remove a scroller he gives range 0.
+ // 2. If the user wants to disable a scroller he sets thumbSize == range
+ // in which case it is logically impossible to scroll.
+ // The scroller shall still be displayed.
+
+ // Ensure that range is >= 0.
+ wxASSERT(range >= 0);
+ if(range < 0)
+ range = 0;
+
+ // Ensure that thumbSize <= range
+ wxASSERT(thumbSize <= range);
+ // Also ensure thumbSize >= 1 but don't complain if it isn't
+ if(thumbSize < 1)
+ thumbSize = 1;
+ // Now make sure it's really less than range, even if we just set it to 1
+ if(thumbSize > range)
+ thumbSize = range;
+
+ bool needScroller = (range != 0);
+
+ // Can potentially set both horizontal and vertical at the same time although this is
+ // probably not very useful.
+ if(orientation & wxHORIZONTAL)
+ {
+ m_scrollRange[0] = range;
+ m_scrollThumb[0] = thumbSize;
+ if(!m_isNativeView)
+ {
+ [m_cocoaNSScrollView setHasHorizontalScroller:needScroller];
+ if(needScroller)
+ SetCocoaScroller([m_cocoaNSScrollView horizontalScroller], orientation, position, thumbSize, range);
+ }
+ }
+
+ if(orientation & wxVERTICAL)
+ {
+ m_scrollRange[1] = range;
+ m_scrollThumb[1] = thumbSize;
+ if(!m_isNativeView)
+ {
+ [m_cocoaNSScrollView setHasVerticalScroller:needScroller];
+ if(needScroller)
+ SetCocoaScroller([m_cocoaNSScrollView verticalScroller], orientation, position, thumbSize, range);
+ }
+ }
+}
+
+int wxWindowCocoaScrollView::GetScrollPos(wxOrientation orient)
+{
+ if((orient & wxBOTH) == wxBOTH)
+ {
+ wxLogError(wxT("GetScrollPos called for wxHORIZONTAL and wxVERTICAL together which makes no sense"));
+ return 0;
+ }
+ int effectiveScrollRange;
+ NSScroller *cocoaScroller;
+ if(orient & wxHORIZONTAL)
+ {
+ effectiveScrollRange = m_scrollRange[0] - m_scrollThumb[0];
+ cocoaScroller = [m_cocoaNSScrollView horizontalScroller];
+ }
+ else if(orient & wxVERTICAL)
+ {
+ effectiveScrollRange = m_scrollRange[1] - m_scrollThumb[1];
+ cocoaScroller = [m_cocoaNSScrollView verticalScroller];
+ }
+ else
+ {
+ wxLogError(wxT("GetScrollPos called without an orientation which makes no sense"));
+ return 0;
+ }
+ if(cocoaScroller == nil)
+ { // Document is not scrolled
+ return 0;
+ }
+ /*
+ The effective range of a scroll bar as defined by wxWidgets is from 0 to (range - thumbSize).
+ That is a scroller at the left/top position is at 0 and a scroller at the bottom/right
+ position is at range-thumbsize.
+
+ The range of an NSScroller is 0.0 to 1.0. Much easier! NOTE: Apple doesn't really specify
+ but GNUStep docs do say that 0.0 is top/left and 1.0 is bottom/right. This is actually
+ in contrast to NSSlider which generally has 1.0 at the TOP when it's done vertically.
+ */
+ CGFloat cocoaScrollPos = [cocoaScroller floatValue];
+ return effectiveScrollRange * cocoaScrollPos;
+}
+
+int wxWindowCocoaScrollView::GetScrollRange(wxOrientation orient)
+{
+ if((orient & wxBOTH) == wxBOTH)
+ {
+ wxLogError(wxT("GetScrollRange called for wxHORIZONTAL and wxVERTICAL together which makes no sense"));
+ return 0;
+ }
+ if(orient & wxHORIZONTAL)
+ {
+ return m_scrollRange[0];
+ }
+ else if(orient & wxVERTICAL)
+ {
+ return m_scrollRange[1];
+ }
+ else
+ {
+ wxLogError(wxT("GetScrollPos called without an orientation which makes no sense"));
+ return 0;
+ }
+}
+
+int wxWindowCocoaScrollView::GetScrollThumb(wxOrientation orient)
+{
+ if((orient & wxBOTH) == wxBOTH)
+ {
+ wxLogError(wxT("GetScrollThumb called for wxHORIZONTAL and wxVERTICAL together which makes no sense"));
+ return 0;
+ }
+ if(orient & wxHORIZONTAL)
+ {
+ return m_scrollThumb[0];
+ }
+ else if(orient & wxVERTICAL)
+ {
+ return m_scrollThumb[1];
+ }
+ else
+ {
+ wxLogError(wxT("GetScrollThumb called without an orientation which makes no sense"));
+ return 0;
+ }
+}
+
+/*!
+ Moves the contents (all existing drawing as well as all all child wxWindow) by the specified
+ amount expressed in the wxWindow's own coordinate system. This is used to implement scrolling
+ but the usage is rather interesting. When scrolling right (e.g. increasing the value of
+ the scroller) you must give a negative delta x (e.g. moving the contents LEFT). Likewise,
+ when scrolling the window down, increasing the value of the scroller, you give a negative
+ delta y which moves the contents up.
+
+ wxCocoa notes: To accomplish this trick in Cocoa we basically do what NSScrollView would
+ have done and that is adjust the content view's bounds origin. The content view is somewhat
+ confusingly the NSClipView which is more or less sort of the pImpl for NSScrollView
+ The real NSView with the user's content (e.g. the "virtual area" in wxWidgets parlance)
+ is called the document view in NSScrollView parlance.
+
+ The bounds origin is basically the exact opposite concept. Whereas in Windows the client
+ coordinate system remains constant and the content must shift left/up for increases
+ of scrolling, in Cocoa the coordinate system is actually the virtual one. So we must
+ instead shift the bounds rectangle right/down to get the effect of the content moving
+ left/up. Basically, it's a higher level interface than that provided by wxWidgets
+ so essentially we're implementing the low-level move content interface in terms of
+ the high-level move the viewport (the bounds) over top that content (the document
+ view which is the virtual area to wx).
+
+ For all intents and purposes that basically just means that we subtract the deltas
+ from the bounds origin and thus a negative delta actually increases the bounds origin
+ and a positive delta actually decreases it. This is absolutely true for the horizontal
+ axis but there's a catch in the vertical axis. If the content view (the clip view) is
+ flipped (and we do this by default) then it works exactly like the horizontal axis.
+ If it is not flipped (i.e. it is in postscript coordinates which are opposite to
+ wxWidgets) then the sense needs to be reversed.
+
+ However, this plays hell with window positions. The frame rects of any child views
+ do not change origin and this is actually important because if they did, the views
+ would send frame changed notifications, not to mention that Cocoa just doesn't really
+ do scrolling that way, it does it the way we do it here.
+
+ To fix this we implement GetPosition for child windows to not merely consult its
+ superview at the Cocoa level in order to do proper Cocoa->wx coordinate transform
+ but to actually consult is parent wxWindow because it makes a big difference if
+ the parent is scrolled. Argh. (FIXME: This isn't actually implemented yet)
+ */
+void wxWindowCocoaScrollView::ScrollWindow(int dx, int dy, const wxRect*)
+{
+ // Update our internal origin so we know how much the application code
+ // expects us to have been scrolled.
+ m_virtualOrigin.x += dx;
+ m_virtualOrigin.y += dy;
+
+ // Scroll the window using the standard Cocoa method of adjusting the
+ // clip view's bounds in the opposite fashion.
+ NSClipView *contentView = [m_cocoaNSScrollView contentView];
+ NSRect clipViewBoundsRect = [contentView bounds];
+ clipViewBoundsRect.origin.x -= dx;
+ if([contentView isFlipped])
+ clipViewBoundsRect.origin.y -= dy;
+ else
+ clipViewBoundsRect.origin.y += dy;
+ [contentView scrollToPoint:clipViewBoundsRect.origin];
+}
+
+void wxWindowCocoaScrollView::_wx_doScroller(NSScroller *sender)
+{
+ wxOrientation orientation;
+ if(sender == [m_cocoaNSScrollView horizontalScroller])
+ orientation = wxHORIZONTAL;
+ else if(sender == [m_cocoaNSScrollView verticalScroller])
+ orientation = wxVERTICAL;
+ else
+ {
+ wxLogDebug(wxT("Received action message from unexpected NSScroller"));
+ return;
+ }
+ // NOTE: Cocoa does not move the scroller for page up/down or line
+ // up/down events. That means the value will be the old value.
+ // For thumbtrack events, the value is the new value.
+ int scrollpos = GetScrollPos(orientation);
+ int commandType;
+ switch([sender hitPart])
+ {
+ default:
+ case NSScrollerNoPart:
+ case NSScrollerKnob: // Drag of knob
+ case NSScrollerKnobSlot: // Jump directly to position
+ commandType = wxEVT_SCROLLWIN_THUMBTRACK;
+ break;
+ case NSScrollerDecrementPage:
+ commandType = wxEVT_SCROLLWIN_PAGEUP;
+ break;
+ case NSScrollerIncrementPage:
+ commandType = wxEVT_SCROLLWIN_PAGEDOWN;
+ break;
+ case NSScrollerDecrementLine:
+ commandType = wxEVT_SCROLLWIN_LINEUP;
+ break;
+ case NSScrollerIncrementLine:
+ commandType = wxEVT_SCROLLWIN_LINEDOWN;
+ break;
+ }
+ wxScrollWinEvent event(commandType, scrollpos, orientation);
+ event.SetEventObject(m_owner);
+ m_owner->HandleWindowEvent(event);
+}
+
+void wxWindowCocoaScrollView::UpdateSizes()
+{
+ // Using the virtual size, figure out what the document frame size should be
+ // NOTE: Assume that the passed in virtualSize is already >= the client size
+ wxSize virtualSize = m_owner->GetVirtualSize();
+
+ // Get the document's current frame
+ NSRect documentViewFrame = [m_owner->GetNSView() frame];
+ NSRect newFrame = documentViewFrame;
+ newFrame.size = NSMakeSize(virtualSize.x, virtualSize.y);
+
+ if(!NSEqualRects(newFrame, documentViewFrame))
+ {
+ [m_owner->GetNSView() setFrame:newFrame];
+ }
+}
+
void wxWindowCocoaScrollView::Cocoa_FrameChanged(void)
{
- wxLogTrace(wxTRACE_COCOA,wxT("Cocoa_FrameChanged"));
+ wxLogTrace(wxTRACE_COCOA,wxT("wxWindowCocoaScrollView=%p::Cocoa_FrameChanged for wxWindow %p"), this, m_owner);
wxSizeEvent event(m_owner->GetSize(), m_owner->GetId());
event.SetEventObject(m_owner);
- m_owner->GetEventHandler()->ProcessEvent(event);
+ m_owner->HandleWindowEvent(event);
+
+ /* If the view is not a native one then it's being managed by wx. In this case the control
+ may decide to change its virtual size and we must update the document view's size to
+ match. For native views the virtual size will never have been set so we do not want
+ to use it at all.
+ */
+ if(!m_isNativeView)
+ UpdateSizes();
}
// ========================================================================
// normally the base classes aren't included, but wxWindow is special
#ifdef __WXUNIVERSAL__
IMPLEMENT_ABSTRACT_CLASS(wxWindowCocoa, wxWindowBase)
-#else
-IMPLEMENT_DYNAMIC_CLASS(wxWindow, wxWindowBase)
#endif
BEGIN_EVENT_TABLE(wxWindowCocoa, wxWindowBase)
m_cocoaNSView = NULL;
m_cocoaHider = NULL;
m_wxCocoaScrollView = NULL;
- m_isBeingDeleted = false;
m_isInPaint = false;
m_visibleTrackingRectManager = NULL;
}
wxASSERT(childView);
[m_cocoaNSView addSubview: childView];
- child->m_isShown = !m_cocoaHider;
}
void wxWindowCocoa::CocoaRemoveFromParent(void)
bool need_debug = cocoaNSView || m_cocoaNSView;
if(need_debug) wxLogTrace(wxTRACE_COCOA_RetainRelease,wxT("wxWindowCocoa=%p::SetNSView [m_cocoaNSView=%p retainCount]=%d"),this,m_cocoaNSView,[m_cocoaNSView retainCount]);
DisassociateNSView(m_cocoaNSView);
- [cocoaNSView retain];
- [m_cocoaNSView release];
+ wxGCSafeRetain(cocoaNSView);
+ wxGCSafeRelease(m_cocoaNSView);
m_cocoaNSView = cocoaNSView;
AssociateNSView(m_cocoaNSView);
if(need_debug) wxLogTrace(wxTRACE_COCOA_RetainRelease,wxT("wxWindowCocoa=%p::SetNSView [cocoaNSView=%p retainCount]=%d"),this,cocoaNSView,[cocoaNSView retainCount]);
WX_NSAffineTransform wxWindowCocoa::CocoaGetWxToBoundsTransform()
{
// TODO: Handle scrolling offset
- NSAffineTransform *transform = wxDC::CocoaGetWxToBoundsTransform([GetNSView() isFlipped], [GetNSView() bounds].size.height);
+ NSAffineTransform *transform = wxCocoaDCImpl::CocoaGetWxToBoundsTransform([GetNSView() isFlipped], [GetNSView() bounds].size.height);
return transform;
}
wxPaintEvent event(m_windowId);
event.SetEventObject(this);
- bool ret = GetEventHandler()->ProcessEvent(event);
+ bool ret = HandleWindowEvent(event);
m_isInPaint = false;
return ret;
}
// Mouse events happen at the NSWindow level so we need to convert
// into our bounds coordinates then convert to wx coordinates.
NSPoint cocoaPoint = [m_cocoaNSView convertPoint:[(NSEvent*)cocoaEvent locationInWindow] fromView:nil];
+ if( m_wxCocoaScrollView != NULL)
+ {
+ // This gets the wx client area (i.e. the visible portion of the content) in
+ // the coordinate system of our (the doucment) view.
+ NSRect documentVisibleRect = [[m_wxCocoaScrollView->GetNSScrollView() contentView] documentVisibleRect];
+ // For horizontal, simply subtract the origin.
+ // e.g. if the origin is at 123 and the user clicks as far left as possible then
+ // the coordinate that wx wants is 0.
+ cocoaPoint.x -= documentVisibleRect.origin.x;
+ if([m_cocoaNSView isFlipped])
+ {
+ // In the flipped view case this works exactly like horizontal.
+ cocoaPoint.y -= documentVisibleRect.origin.y;
+ }
+ // For vertical we have to mind non-flipped (e.g. y=0 at bottom) views.
+ // We also need to mind the fact that we're still in Cocoa coordinates
+ // and not wx coordinates. The wx coordinate translation will still occur
+ // and that is going to be wxY = boundsH - cocoaY for non-flipped views.
+
+ // When we consider scrolling we are truly interested in how far the top
+ // edge of the bounds rectangle is scrolled off the screen.
+ // Assuming the bounds origin is 0 (which is an assumption we make in
+ // wxCocoa since wxWidgets has no analog to it) then the top edge of
+ // the bounds rectangle is simply its height. The top edge of the
+ // documentVisibleRect (e.g. the client area) is its height plus
+ // its origin.
+ // Thus, we simply need add the distance between the bounds top
+ // and the client (docuemntVisibleRect) top.
+ // Or putting it another way, we subtract the distance between the
+ // client top and the bounds top.
+ else
+ {
+ NSRect bounds = [m_cocoaNSView bounds];
+ CGFloat scrollYOrigin = (bounds.size.height - (documentVisibleRect.origin.y + documentVisibleRect.size.height));
+ cocoaPoint.y += scrollYOrigin;
+ }
+ }
+
NSPoint pointWx = CocoaTransformBoundsToWx(cocoaPoint);
// FIXME: Should we be adjusting for client area origin?
const wxPoint &clientorigin = GetClientAreaOrigin();
wxMouseEvent event(wxEVT_MOTION);
InitMouseEvent(event,theEvent);
wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::Cocoa_mouseMoved @%d,%d"),this,event.m_x,event.m_y);
- return GetEventHandler()->ProcessEvent(event);
+ return HandleWindowEvent(event);
}
void wxWindowCocoa::Cocoa_synthesizeMouseMoved()
event.SetId(GetId());
wxLogTrace(wxTRACE_COCOA,wxT("wxwin=%p Synthesized Mouse Moved @%d,%d"),this,event.m_x,event.m_y);
- GetEventHandler()->ProcessEvent(event);
+ HandleWindowEvent(event);
}
bool wxWindowCocoa::Cocoa_mouseEntered(WX_NSEvent theEvent)
wxMouseEvent event(wxEVT_ENTER_WINDOW);
InitMouseEvent(event,theEvent);
- wxLogTrace(wxTRACE_COCOA,wxT("wxwin=%p Mouse Entered @%d,%d"),this,event.m_x,event.m_y);
- return GetEventHandler()->ProcessEvent(event);
+ wxLogTrace(wxTRACE_COCOA_TrackingRect,wxT("wxwin=%p Mouse Entered TR#%d @%d,%d"),this,[theEvent trackingNumber], event.m_x,event.m_y);
+ return HandleWindowEvent(event);
}
else
return false;
wxMouseEvent event(wxEVT_LEAVE_WINDOW);
InitMouseEvent(event,theEvent);
- wxLogTrace(wxTRACE_COCOA,wxT("wxwin=%p Mouse Exited @%d,%d"),this,event.m_x,event.m_y);
- return GetEventHandler()->ProcessEvent(event);
+ wxLogTrace(wxTRACE_COCOA_TrackingRect,wxT("wxwin=%p Mouse Exited TR#%d @%d,%d"),this,[theEvent trackingNumber],event.m_x,event.m_y);
+ return HandleWindowEvent(event);
}
else
return false;
wxMouseEvent event([theEvent clickCount]<2?wxEVT_LEFT_DOWN:wxEVT_LEFT_DCLICK);
InitMouseEvent(event,theEvent);
wxLogTrace(wxTRACE_COCOA,wxT("Mouse Down @%d,%d num clicks=%d"),event.m_x,event.m_y,[theEvent clickCount]);
- return GetEventHandler()->ProcessEvent(event);
+ return HandleWindowEvent(event);
}
bool wxWindowCocoa::Cocoa_mouseDragged(WX_NSEvent theEvent)
InitMouseEvent(event,theEvent);
event.m_leftDown = true;
wxLogTrace(wxTRACE_COCOA,wxT("Mouse Drag @%d,%d"),event.m_x,event.m_y);
- return GetEventHandler()->ProcessEvent(event);
+ return HandleWindowEvent(event);
}
bool wxWindowCocoa::Cocoa_mouseUp(WX_NSEvent theEvent)
wxMouseEvent event(wxEVT_LEFT_UP);
InitMouseEvent(event,theEvent);
wxLogTrace(wxTRACE_COCOA,wxT("Mouse Up @%d,%d"),event.m_x,event.m_y);
- return GetEventHandler()->ProcessEvent(event);
+ return HandleWindowEvent(event);
}
bool wxWindowCocoa::Cocoa_rightMouseDown(WX_NSEvent theEvent)
wxMouseEvent event([theEvent clickCount]<2?wxEVT_RIGHT_DOWN:wxEVT_RIGHT_DCLICK);
InitMouseEvent(event,theEvent);
wxLogDebug(wxT("Mouse Down @%d,%d num clicks=%d"),event.m_x,event.m_y,[theEvent clickCount]);
- return GetEventHandler()->ProcessEvent(event);
+ return HandleWindowEvent(event);
}
bool wxWindowCocoa::Cocoa_rightMouseDragged(WX_NSEvent theEvent)
InitMouseEvent(event,theEvent);
event.m_rightDown = true;
wxLogDebug(wxT("Mouse Drag @%d,%d"),event.m_x,event.m_y);
- return GetEventHandler()->ProcessEvent(event);
+ return HandleWindowEvent(event);
}
bool wxWindowCocoa::Cocoa_rightMouseUp(WX_NSEvent theEvent)
wxMouseEvent event(wxEVT_RIGHT_UP);
InitMouseEvent(event,theEvent);
wxLogDebug(wxT("Mouse Up @%d,%d"),event.m_x,event.m_y);
- return GetEventHandler()->ProcessEvent(event);
+ return HandleWindowEvent(event);
}
bool wxWindowCocoa::Cocoa_otherMouseDown(WX_NSEvent theEvent)
void wxWindowCocoa::Cocoa_FrameChanged(void)
{
- wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::Cocoa_FrameChanged"),this);
- if(m_visibleTrackingRectManager != NULL)
- m_visibleTrackingRectManager->RebuildTrackingRect();
- wxSizeEvent event(GetSize(), m_windowId);
- event.SetEventObject(this);
- GetEventHandler()->ProcessEvent(event);
+ // We always get this message for the real NSView which may have been
+ // enclosed in an NSScrollView. If that's the case then what we're
+ // effectively getting here is a notifcation that the
+ // virtual sized changed.. which we don't need to send on since
+ // wx has no concept of this whatsoever.
+ bool isViewForSuperview = (m_wxCocoaScrollView == NULL);
+ if(isViewForSuperview)
+ {
+ wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::Cocoa_FrameChanged"),this);
+ if(m_visibleTrackingRectManager != NULL)
+ m_visibleTrackingRectManager->RebuildTrackingRect();
+ wxSizeEvent event(GetSize(), m_windowId);
+ event.SetEventObject(this);
+ HandleWindowEvent(event);
+ }
+ else
+ {
+ wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::Cocoa_FrameChanged ignored"),this);
+ }
}
bool wxWindowCocoa::Cocoa_resetCursorRects()
{
wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::Cocoa_resetCursorRects"),this);
+
+ // When we are called there may be a queued tracking rect event (mouse entered or exited) and
+ // we won't know it. A specific example is wxGenericHyperlinkCtrl changing the cursor from its
+ // mouse exited event. If the control happens to share the edge with its parent window which is
+ // also tracking mouse events then Cocoa receives two mouse exited events from the window server.
+ // The first one will cause wxGenericHyperlinkCtrl to call wxWindow::SetCursor which will
+ // invaildate the cursor rect causing Cocoa to schedule cursor rect reset with the run loop
+ // which willl in turn call us before exiting for the next user event.
+
+ // If we are the parent window then rebuilding our tracking rectangle will cause us to miss
+ // our mouse exited event because the already queued event will have the old tracking rect
+ // tag. The simple solution is to only rebuild our tracking rect if we need to.
+
if(m_visibleTrackingRectManager != NULL)
- m_visibleTrackingRectManager->RebuildTrackingRect();
+ m_visibleTrackingRectManager->RebuildTrackingRectIfNeeded();
if(!m_cursor.GetNSCursor())
return false;
return true;
}
+bool wxWindowCocoa::SetCursor(const wxCursor &cursor)
+{
+ if(!wxWindowBase::SetCursor(cursor))
+ return false;
+
+ // Set up the cursor rect so that invalidateCursorRectsForView: will destroy it.
+ // If we don't do this then Cocoa thinks (rightly) that we don't have any cursor
+ // rects and thus won't ever call resetCursorRects.
+ [GetNSView() addCursorRect: [GetNSView() visibleRect] cursor: m_cursor.GetNSCursor()];
+
+ // Invalidate the cursor rects so the cursor will change
+ // Note that it is not enough to remove the old one (if any) and add the new one.
+ // For the rects to work properly, Cocoa itself must call resetCursorRects.
+ [[GetNSView() window] invalidateCursorRectsForView:GetNSView()];
+ return true;
+}
+
bool wxWindowCocoa::Cocoa_viewDidMoveToWindow()
{
wxLogTrace(wxTRACE_COCOA,wxT("wxWindow=%p::viewDidMoveToWindow"),this);
// If state isn't changing, return false
if(!m_cocoaHider)
return false;
+
+ // Replace the stand-in view with the real one and destroy the dummy view
CocoaReplaceView(m_cocoaHider->GetNSView(), cocoaView);
wxASSERT(![m_cocoaHider->GetNSView() superview]);
delete m_cocoaHider;
m_cocoaHider = NULL;
wxASSERT([cocoaView superview]);
+
+ // Schedule an update of the key view loop (NOTE: 10.4+ only.. argh)
+ NSWindow *window = [cocoaView window];
+ if(window != nil)
+ {
+ // Delay this until returning to the event loop for a couple of reasons:
+ // 1. If a lot of stuff is shown/hidden we avoid recalculating needlessly
+ // 2. NSWindow does not seem to see the newly shown views if we do it right now.
+ if([window respondsToSelector:@selector(recalculateKeyViewLoop)])
+ [window performSelector:@selector(recalculateKeyViewLoop) withObject:nil afterDelay:0.0];
+ }
}
else
{
// If state isn't changing, return false
if(m_cocoaHider)
return false;
+
+ // Handle the first responder
+ NSWindow *window = [cocoaView window];
+ if(window != nil)
+ {
+ NSResponder *firstResponder = [window firstResponder];
+ if([firstResponder isKindOfClass:[NSView class]] && [(NSView*)firstResponder isDescendantOf:cocoaView])
+ {
+ BOOL didResign = [window makeFirstResponder:nil];
+ // If the current first responder (one of our subviews) refuses to give
+ // up its status, then fail now and don't hide this view
+ if(didResign == NO)
+ return false;
+ }
+ }
+
+ // Create a new view to stand in for the real one (via wxWindowCocoaHider) and replace
+ // the real one with the stand in.
m_cocoaHider = new wxWindowCocoaHider(this);
// NOTE: replaceSubview:with will cause m_cocaNSView to be
// (auto)released which balances out addSubview
void wxWindow::DoScreenToClient(int *x, int *y) const
{
- // TODO
+ // Point in cocoa screen coordinates:
+ NSPoint cocoaScreenPoint = OriginInCocoaScreenCoordinatesForRectInWxDisplayCoordinates(x!=NULL?*x:0, y!=NULL?*y:0, 0, 0, false);
+ NSView *clientView = const_cast<wxWindow*>(this)->GetNSView();
+ NSWindow *theWindow = [clientView window];
+
+ // Point in window's base coordinate system:
+ NSPoint windowPoint = [theWindow convertScreenToBase:cocoaScreenPoint];
+ // Point in view's bounds coordinate system
+ NSPoint boundsPoint = [clientView convertPoint:windowPoint fromView:nil];
+ // Point in wx client coordinates:
+ NSPoint theWxClientPoint = CocoaTransformNSViewBoundsToWx(clientView, boundsPoint);
+ if(x!=NULL)
+ *x = theWxClientPoint.x;
+ if(y!=NULL)
+ *y = theWxClientPoint.y;
}
void wxWindow::DoClientToScreen(int *x, int *y) const
{
- // TODO
+ // Point in wx client coordinates
+ NSPoint theWxClientPoint = NSMakePoint(x!=NULL?*x:0, y!=NULL?*y:0);
+
+ NSView *clientView = const_cast<wxWindow*>(this)->GetNSView();
+
+ // Point in the view's bounds coordinate system
+ NSPoint boundsPoint = CocoaTransformNSViewWxToBounds(clientView, theWxClientPoint);
+
+ // Point in the window's base coordinate system
+ NSPoint windowPoint = [clientView convertPoint:boundsPoint toView:nil];
+
+ NSWindow *theWindow = [clientView window];
+ // Point in Cocoa's screen coordinates
+ NSPoint screenPoint = [theWindow convertBaseToScreen:windowPoint];
+
+ // Act as though this was the origin of a 0x0 rectangle
+ NSRect screenPointRect = NSMakeRect(screenPoint.x, screenPoint.y, 0, 0);
+
+ // Convert that rectangle to wx coordinates
+ wxPoint theWxScreenPoint = OriginInWxDisplayCoordinatesForRectInCocoaScreenCoordinates(screenPointRect);
+ if(*x)
+ *x = theWxScreenPoint.x;
+ if(*y)
+ *y = theWxScreenPoint.y;
}
// Get size *available for subwindows* i.e. excluding menu bar etc.
int wxWindow::GetCharHeight() const
{
// TODO
- return 0;
+ return 10;
}
int wxWindow::GetCharWidth() const
{
// TODO
- return 0;
+ return 5;
}
-void wxWindow::GetTextExtent(const wxString& string, int *x, int *y,
- int *descent, int *externalLeading, const wxFont *theFont) const
+void wxWindow::DoGetTextExtent(const wxString& string, int *outX, int *outY,
+ int *outDescent, int *outExternalLeading, const wxFont *inFont) const
{
- // TODO
+ // FIXME: This obviously ignores the window's font (if any) along with any size
+ // transformations. However, it's better than nothing.
+ // We don't create a wxClientDC because we don't want to accidently be able to use
+ // it for drawing.
+ wxClientDC tmpdc(const_cast<wxWindow*>(this));
+ return tmpdc.GetTextExtent(string, outX, outY, outDescent, outExternalLeading, inFont);
}
// Coordinates relative to the window
int wxWindow::GetScrollPos(int orient) const
{
- // TODO
- return 0;
+ if(m_wxCocoaScrollView != NULL)
+ return m_wxCocoaScrollView->GetScrollPos(static_cast<wxOrientation>(orient & wxBOTH));
+ else
+ return 0;
}
// This now returns the whole range, not just the number
// of positions that we can scroll.
int wxWindow::GetScrollRange(int orient) const
{
- // TODO
- return 0;
+ if(m_wxCocoaScrollView != NULL)
+ return m_wxCocoaScrollView->GetScrollRange(static_cast<wxOrientation>(orient & wxBOTH));
+ else
+ return 0;
}
int wxWindow::GetScrollThumb(int orient) const
{
- // TODO
- return 0;
+ if(m_wxCocoaScrollView != NULL)
+ return m_wxCocoaScrollView->GetScrollThumb(static_cast<wxOrientation>(orient & wxBOTH));
+ else
+ return 0;
}
void wxWindow::SetScrollPos(int orient, int pos, bool refresh)
{
- // TODO
+ if(m_wxCocoaScrollView != NULL)
+ return m_wxCocoaScrollView->SetScrollPos(static_cast<wxOrientation>(orient & wxBOTH), pos);
}
void wxWindow::CocoaCreateNSScrollView()
int range, bool refresh)
{
CocoaCreateNSScrollView();
- // TODO
+ m_wxCocoaScrollView->SetScrollbar(orient, pos, thumbVisible, range);
+ // TODO: Handle refresh (if we even need to)
}
// Does a physical scroll
void wxWindow::ScrollWindow(int dx, int dy, const wxRect *rect)
{
- // TODO
+ if(m_wxCocoaScrollView != NULL)
+ m_wxCocoaScrollView->ScrollWindow(dx, dy, rect);
}
void wxWindow::DoSetVirtualSize( int x, int y )
{
+ // Call wxWindowBase method which will set m_virtualSize to the appropriate value,
+ // possibly not what the caller passed in. For example, the current implementation
+ // clamps the width and height to within the min/max virtual ranges.
+ // wxDefaultCoord is passed through unchanged but then GetVirtualSize() will correct
+ // that by returning effectively max(virtual, client)
wxWindowBase::DoSetVirtualSize(x,y);
+ // Create the scroll view if it hasn't been already.
CocoaCreateNSScrollView();
- [m_cocoaNSView setFrameSize:NSMakeSize(m_virtualSize.x,m_virtualSize.y)];
+
+ // The GetVirtualSize automatically increases the size to max(client,virtual)
+ m_wxCocoaScrollView->UpdateSizes();
}
bool wxWindow::SetFont(const wxFont& font)
{
- // TODO
- return true;
+ // FIXME: We may need to handle wx font inheritance.
+ return wxWindowBase::SetFont(font);
}
#if 0 // these are used when debugging the algorithm.
class CocoaWindowCompareContext
{
- DECLARE_NO_COPY_CLASS(CocoaWindowCompareContext)
+ wxDECLARE_NO_COPY_CLASS(CocoaWindowCompareContext);
public:
CocoaWindowCompareContext(); // Not implemented
CocoaWindowCompareContext(NSView *target, NSArray *subviews)
return NULL;
}
+// ========================================================================
+// wxCocoaMouseMovedEventSynthesizer
+// ========================================================================
+
+#define wxTRACE_COCOA_MouseMovedSynthesizer wxT("COCOA_MouseMovedSynthesizer")
+
+/* This class registers one run loop observer to cover all windows registered with it.
+ * It will register the observer when the first view is registerd and unregister the
+ * observer when the last view is unregistered.
+ * It is instantiated as a static s_mouseMovedSynthesizer in this file although there
+ * is no reason it couldn't be instantiated multiple times.
+ */
+class wxCocoaMouseMovedEventSynthesizer
+{
+ wxDECLARE_NO_COPY_CLASS(wxCocoaMouseMovedEventSynthesizer);
+public:
+ wxCocoaMouseMovedEventSynthesizer()
+ { m_lastScreenMouseLocation = NSZeroPoint;
+ }
+ ~wxCocoaMouseMovedEventSynthesizer();
+ void RegisterWxCocoaView(wxCocoaNSView *aView);
+ void UnregisterWxCocoaView(wxCocoaNSView *aView);
+ void SynthesizeMouseMovedEvent();
+
+protected:
+ void AddRunLoopObserver();
+ void RemoveRunLoopObserver();
+ wxCFRef<CFRunLoopObserverRef> m_runLoopObserver;
+ std::list<wxCocoaNSView*> m_registeredViews;
+ NSPoint m_lastScreenMouseLocation;
+ static void SynthesizeMouseMovedEvent(CFRunLoopObserverRef observer, CFRunLoopActivity activity, void *info);
+};
+
+void wxCocoaMouseMovedEventSynthesizer::RegisterWxCocoaView(wxCocoaNSView *aView)
+{
+ m_registeredViews.push_back(aView);
+ wxLogTrace(wxTRACE_COCOA_MouseMovedSynthesizer, wxT("Registered wxCocoaNSView=%p"), aView);
+
+ if(!m_registeredViews.empty() && m_runLoopObserver == NULL)
+ {
+ AddRunLoopObserver();
+ }
+}
+
+void wxCocoaMouseMovedEventSynthesizer::UnregisterWxCocoaView(wxCocoaNSView *aView)
+{
+ m_registeredViews.remove(aView);
+ wxLogTrace(wxTRACE_COCOA_MouseMovedSynthesizer, wxT("Unregistered wxCocoaNSView=%p"), aView);
+ if(m_registeredViews.empty() && m_runLoopObserver != NULL)
+ {
+ RemoveRunLoopObserver();
+ }
+}
+
+wxCocoaMouseMovedEventSynthesizer::~wxCocoaMouseMovedEventSynthesizer()
+{
+ if(!m_registeredViews.empty())
+ {
+ // This means failure to clean up so we report on it as a debug message.
+ wxLogDebug(wxT("There are still %d wxCocoaNSView registered to receive mouse moved events at static destruction time"), m_registeredViews.size());
+ m_registeredViews.clear();
+ }
+ if(m_runLoopObserver != NULL)
+ {
+ // This should not occur unless m_registeredViews was not empty since the last object unregistered should have done this.
+ wxLogDebug(wxT("Removing run loop observer during static destruction time."));
+ RemoveRunLoopObserver();
+ }
+}
+
+void wxCocoaMouseMovedEventSynthesizer::SynthesizeMouseMovedEvent(CFRunLoopObserverRef observer, CFRunLoopActivity activity, void *info)
+{
+ reinterpret_cast<wxCocoaMouseMovedEventSynthesizer*>(info)->SynthesizeMouseMovedEvent();
+}
+
+void wxCocoaMouseMovedEventSynthesizer::AddRunLoopObserver()
+{
+ CFRunLoopObserverContext observerContext =
+ { 0
+ , this
+ , NULL
+ , NULL
+ , NULL
+ };
+
+ // The kCFRunLoopExit observation point is used such that we hook the run loop after it has already decided that
+ // it is going to exit which is generally for the purpose of letting the event loop process the next Cocoa event.
+
+ // Executing our procedure within the run loop (e.g. kCFRunLoopBeforeWaiting which was used before) results
+ // in our observer procedure being called before the run loop has decided that it is going to return control to
+ // the Cocoa event loop. One major problem is uncovered by the wxGenericHyperlinkCtrl (consider this to be "user
+ // code") which changes the window's cursor and thus causes the cursor rectangle's to be invalidated.
+
+ // Cocoa implements this invalidation using a delayed notification scheme whereby the resetCursorRects method
+ // won't be called until the CFRunLoop gets around to it. If the CFRunLoop has not yet exited then it will get
+ // around to it before letting the event loop do its work. This has some very odd effects on the way the
+ // newly created tracking rects function. In particular, we will often miss the mouseExited: message if the
+ // user flicks the mouse quickly enough such that the mouse is already outside of the tracking rect by the
+ // time the new one is built.
+
+ // Observing from the kCFRunLoopExit point gives Cocoa's event loop an opportunity to chew some events before it cedes
+ // control back to the CFRunLoop, thus causing the delayed notifications to fire at an appropriate time and
+ // the mouseExited: message to be sent properly.
+
+ m_runLoopObserver.reset(CFRunLoopObserverCreate(kCFAllocatorDefault, kCFRunLoopExit, TRUE, 0, SynthesizeMouseMovedEvent, &observerContext));
+ CFRunLoopAddObserver([[NSRunLoop currentRunLoop] getCFRunLoop], m_runLoopObserver, kCFRunLoopCommonModes);
+ wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Added tracking rect run loop observer"));
+}
+
+void wxCocoaMouseMovedEventSynthesizer::RemoveRunLoopObserver()
+{
+ CFRunLoopRemoveObserver([[NSRunLoop currentRunLoop] getCFRunLoop], m_runLoopObserver, kCFRunLoopCommonModes);
+ m_runLoopObserver.reset();
+ wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Removed tracking rect run loop observer"));
+}
+
+void wxCocoaMouseMovedEventSynthesizer::SynthesizeMouseMovedEvent()
+{
+ NSPoint screenMouseLocation = [NSEvent mouseLocation];
+ // Checking the last mouse location is done for a few reasons:
+ // 1. We are observing every iteration of the event loop so we'd be sending out a lot of extraneous events
+ // telling the app the mouse moved when the user hit a key for instance.
+ // 2. When handling the mouse moved event, user code can do something to the view which will cause Cocoa to
+ // call resetCursorRects. Cocoa does this by using a delayed notification which means the event loop gets
+ // pumped once which would mean that if we didn't check the mouse location we'd get into a never-ending
+ // loop causing the tracking rectangles to constantly be reset.
+ if(screenMouseLocation.x != m_lastScreenMouseLocation.x || screenMouseLocation.y != m_lastScreenMouseLocation.y)
+ {
+ m_lastScreenMouseLocation = screenMouseLocation;
+ wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Synthesizing mouse moved at screen (%f,%f)"), screenMouseLocation.x, screenMouseLocation.y);
+ for(std::list<wxCocoaNSView*>::iterator i = m_registeredViews.begin(); i != m_registeredViews.end(); ++i)
+ {
+ (*i)->Cocoa_synthesizeMouseMoved();
+ }
+ }
+}
+
+// Singleton used for all views:
+static wxCocoaMouseMovedEventSynthesizer s_mouseMovedSynthesizer;
// ========================================================================
// wxCocoaTrackingRectManager
: m_window(window)
{
m_isTrackingRectActive = false;
- m_runLoopObserver = NULL;
BuildTrackingRect();
}
{
[m_window->GetNSView() removeTrackingRect:m_trackingRectTag];
m_isTrackingRectActive = false;
+ wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("%s@%p: Removed tracking rect #%d"), m_window->GetClassInfo()->GetClassName(), m_window, m_trackingRectTag);
}
// If we were doing periodic events we need to clear those too
StopSynthesizingEvents();
void wxCocoaTrackingRectManager::StopSynthesizingEvents()
{
- if(m_runLoopObserver != NULL)
- {
- CFRunLoopRemoveObserver([[NSRunLoop currentRunLoop] getCFRunLoop], m_runLoopObserver, kCFRunLoopCommonModes);
- CFRelease(m_runLoopObserver);
- m_runLoopObserver = NULL;
- }
+ s_mouseMovedSynthesizer.UnregisterWxCocoaView(m_window);
}
void wxCocoaTrackingRectManager::BuildTrackingRect()
wxAutoNSAutoreleasePool pool;
wxASSERT_MSG(!m_isTrackingRectActive, wxT("Tracking rect was not cleared"));
- if([m_window->GetNSView() window] != nil)
+
+ NSView *theView = m_window->GetNSView();
+
+ if([theView window] != nil)
{
- m_trackingRectTag = [m_window->GetNSView() addTrackingRect:[m_window->GetNSView() visibleRect] owner:m_window->GetNSView() userData:NULL assumeInside:NO];
+ NSRect visibleRect = [theView visibleRect];
+
+ m_trackingRectTag = [theView addTrackingRect:visibleRect owner:theView userData:NULL assumeInside:NO];
+ m_trackingRectInWindowCoordinates = [theView convertRect:visibleRect toView:nil];
m_isTrackingRectActive = true;
+
+ wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("%s@%p: Added tracking rect #%d"), m_window->GetClassInfo()->GetClassName(), m_window, m_trackingRectTag);
}
}
-static NSPoint s_lastScreenMouseLocation = NSZeroPoint;
-
-static void SynthesizeMouseMovedEvent(CFRunLoopObserverRef observer, CFRunLoopActivity activity, void *info)
+void wxCocoaTrackingRectManager::BeginSynthesizingEvents()
{
- NSPoint screenMouseLocation = [NSEvent mouseLocation];
- if(screenMouseLocation.x != s_lastScreenMouseLocation.x || screenMouseLocation.y != s_lastScreenMouseLocation.y)
- {
- wxCocoaNSView *win = reinterpret_cast<wxCocoaNSView*>(info);
- win->Cocoa_synthesizeMouseMoved();
- }
+ s_mouseMovedSynthesizer.RegisterWxCocoaView(m_window);
}
-void wxCocoaTrackingRectManager::BeginSynthesizingEvents()
+void wxCocoaTrackingRectManager::RebuildTrackingRectIfNeeded()
{
- CFRunLoopObserverContext observerContext =
- { 0
- , static_cast<wxCocoaNSView*>(m_window)
- , NULL
- , NULL
- , NULL
- };
- m_runLoopObserver = CFRunLoopObserverCreate(kCFAllocatorDefault, kCFRunLoopBeforeWaiting, TRUE, 0, SynthesizeMouseMovedEvent, &observerContext);
- CFRunLoopAddObserver([[NSRunLoop currentRunLoop] getCFRunLoop], m_runLoopObserver, kCFRunLoopCommonModes);
+ if(m_isTrackingRectActive)
+ {
+ NSView *theView = m_window->GetNSView();
+ NSRect currentRect = [theView convertRect:[theView visibleRect] toView:nil];
+ if(NSEqualRects(m_trackingRectInWindowCoordinates,currentRect))
+ {
+ wxLogTrace(wxTRACE_COCOA_TrackingRect, wxT("Ignored request to rebuild TR#%d"), m_trackingRectTag);
+ return;
+ }
+ }
+ RebuildTrackingRect();
}
void wxCocoaTrackingRectManager::RebuildTrackingRect()
projects / wxWidgets.git / blobdiff