1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: mac/toplevel.cpp
3 // Purpose: implements wxTopLevelWindow for Mac
4 // Author: Stefan Csomor
8 // Copyright: (c) 2001-2004 Stefan Csomor
9 // License: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "toplevel.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
33 #include "wx/toplevel.h"
35 #include "wx/string.h"
38 #include "wx/settings.h"
41 #include "wx/mac/uma.h"
42 #include "wx/mac/aga.h"
44 #include "wx/tooltip.h"
46 #if wxUSE_SYSTEM_OPTIONS
47 #include "wx/sysopt.h"
50 #include <ToolUtils.h>
52 // ----------------------------------------------------------------------------
54 // ----------------------------------------------------------------------------
56 // list of all frames and modeless dialogs
57 wxWindowList wxModelessWindows
;
59 static pascal long wxShapedMacWindowDef(short varCode
, WindowRef window
, SInt16 message
, SInt32 param
);
61 // ============================================================================
62 // wxTopLevelWindowMac implementation
63 // ============================================================================
65 BEGIN_EVENT_TABLE(wxTopLevelWindowMac
, wxTopLevelWindowBase
)
69 // ---------------------------------------------------------------------------
71 // ---------------------------------------------------------------------------
73 extern long wxMacTranslateKey(unsigned char key
, unsigned char code
) ;
75 static const EventTypeSpec eventList
[] =
77 // TODO remove control related event like key and mouse (except for WindowLeave events)
79 { kEventClassTextInput
, kEventTextInputUnicodeForKeyEvent
} ,
81 { kEventClassKeyboard
, kEventRawKeyDown
} ,
82 { kEventClassKeyboard
, kEventRawKeyRepeat
} ,
83 { kEventClassKeyboard
, kEventRawKeyUp
} ,
84 { kEventClassKeyboard
, kEventRawKeyModifiersChanged
} ,
87 { kEventClassWindow
, kEventWindowShown
} ,
88 { kEventClassWindow
, kEventWindowActivated
} ,
89 { kEventClassWindow
, kEventWindowDeactivated
} ,
90 { kEventClassWindow
, kEventWindowBoundsChanging
} ,
91 { kEventClassWindow
, kEventWindowBoundsChanged
} ,
92 { kEventClassWindow
, kEventWindowClose
} ,
94 // we have to catch these events on the toplevel window level, as controls don't get the
95 // raw mouse events anymore
97 { kEventClassMouse
, kEventMouseDown
} ,
98 { kEventClassMouse
, kEventMouseUp
} ,
99 { kEventClassMouse
, kEventMouseWheelMoved
} ,
100 { kEventClassMouse
, kEventMouseMoved
} ,
101 { kEventClassMouse
, kEventMouseDragged
} ,
104 static pascal OSStatus
TextInputEventHandler( EventHandlerCallRef handler
, EventRef event
, void *data
)
106 OSStatus result
= eventNotHandledErr
;
108 wxWindow
* focus
= wxWindow::FindFocus() ;
116 GetEventParameter( event
, kEventParamTextInputSendKeyboardEvent
,typeEventRef
,NULL
,sizeof(rawEvent
),NULL
,&rawEvent
) ;
118 GetEventParameter( rawEvent
, kEventParamKeyMacCharCodes
, typeChar
, NULL
,sizeof(char), NULL
,&charCode
);
119 GetEventParameter( rawEvent
, kEventParamKeyCode
, typeUInt32
, NULL
, sizeof(UInt32
), NULL
, &keyCode
);
120 GetEventParameter( rawEvent
, kEventParamKeyModifiers
, typeUInt32
, NULL
, sizeof(UInt32
), NULL
, &modifiers
);
121 GetEventParameter( rawEvent
, kEventParamMouseLocation
, typeQDPoint
, NULL
,
122 sizeof( Point
), NULL
, &point
);
124 switch ( GetEventKind( event
) )
126 case kEventTextInputUnicodeForKeyEvent
:
127 // this is only called when no default handler has jumped in, eg a wxControl on a floater window does not
128 // get its own kEventTextInputUnicodeForKeyEvent, so we route back the
129 wxControl
* control
= wxDynamicCast( focus
, wxControl
) ;
132 ControlRef macControl
= (ControlRef
) control
->GetHandle() ;
135 ::HandleControlKey( macControl
, keyCode
, charCode
, modifiers
) ;
140 // this may lead to double events sent to a window in case all handlers have skipped the key down event
141 UInt32 when = EventTimeToTicks( GetEventTime( event ) ) ;
142 UInt32 message = (keyCode << 8) + charCode;
144 if ( (focus != NULL) && wxTheApp->MacSendKeyDownEvent(
145 focus , message , modifiers , when , point.h , point.v ) )
156 static pascal OSStatus
KeyboardEventHandler( EventHandlerCallRef handler
, EventRef event
, void *data
)
158 OSStatus result
= eventNotHandledErr
;
160 wxWindow
* focus
= wxWindow::FindFocus() ;
168 UInt32 when
= EventTimeToTicks( GetEventTime( event
) ) ;
170 GetEventParameter( event
, kEventParamKeyMacCharCodes
, typeChar
, NULL
,sizeof(char), NULL
,&charCode
);
171 GetEventParameter( event
, kEventParamKeyCode
, typeUInt32
, NULL
, sizeof(UInt32
), NULL
, &keyCode
);
172 GetEventParameter(event
, kEventParamKeyModifiers
, typeUInt32
, NULL
, sizeof(UInt32
), NULL
, &modifiers
);
173 GetEventParameter( event
, kEventParamMouseLocation
, typeQDPoint
, NULL
,
174 sizeof( Point
), NULL
, &point
);
176 UInt32 message
= (keyCode
<< 8) + charCode
;
177 switch( GetEventKind( event
) )
179 case kEventRawKeyRepeat
:
180 case kEventRawKeyDown
:
182 WXEVENTREF formerEvent
= wxTheApp
->MacGetCurrentEvent() ;
183 WXEVENTHANDLERCALLREF formerHandler
= wxTheApp
->MacGetCurrentEventHandlerCallRef() ;
184 wxTheApp
->MacSetCurrentEvent( event
, handler
) ;
185 if ( (focus
!= NULL
) && wxTheApp
->MacSendKeyDownEvent(
186 focus
, message
, modifiers
, when
, point
.h
, point
.v
) )
190 wxTheApp
->MacSetCurrentEvent( formerEvent
, formerHandler
) ;
193 case kEventRawKeyUp
:
194 if ( (focus
!= NULL
) && wxTheApp
->MacSendKeyUpEvent(
195 focus
, message
, modifiers
, when
, point
.h
, point
.v
) )
200 case kEventRawKeyModifiersChanged
:
202 wxKeyEvent
event(wxEVT_KEY_DOWN
);
204 event
.m_shiftDown
= modifiers
& shiftKey
;
205 event
.m_controlDown
= modifiers
& controlKey
;
206 event
.m_altDown
= modifiers
& optionKey
;
207 event
.m_metaDown
= modifiers
& cmdKey
;
211 event
.m_timeStamp
= when
;
212 wxWindow
* focus
= wxWindow::FindFocus() ;
213 event
.SetEventObject(focus
);
215 if ( focus
&& (modifiers
^ wxTheApp
->s_lastModifiers
) & controlKey
)
217 event
.m_keyCode
= WXK_CONTROL
;
218 event
.SetEventType( ( modifiers
& controlKey
) ? wxEVT_KEY_DOWN
: wxEVT_KEY_UP
) ;
219 focus
->GetEventHandler()->ProcessEvent( event
) ;
221 if ( focus
&& (modifiers
^ wxTheApp
->s_lastModifiers
) & shiftKey
)
223 event
.m_keyCode
= WXK_SHIFT
;
224 event
.SetEventType( ( modifiers
& shiftKey
) ? wxEVT_KEY_DOWN
: wxEVT_KEY_UP
) ;
225 focus
->GetEventHandler()->ProcessEvent( event
) ;
227 if ( focus
&& (modifiers
^ wxTheApp
->s_lastModifiers
) & optionKey
)
229 event
.m_keyCode
= WXK_ALT
;
230 event
.SetEventType( ( modifiers
& optionKey
) ? wxEVT_KEY_DOWN
: wxEVT_KEY_UP
) ;
231 focus
->GetEventHandler()->ProcessEvent( event
) ;
233 if ( focus
&& (modifiers
^ wxTheApp
->s_lastModifiers
) & cmdKey
)
235 event
.m_keyCode
= WXK_COMMAND
;
236 event
.SetEventType( ( modifiers
& cmdKey
) ? wxEVT_KEY_DOWN
: wxEVT_KEY_UP
) ;
237 focus
->GetEventHandler()->ProcessEvent( event
) ;
239 wxTheApp
->s_lastModifiers
= modifiers
;
247 // we don't interfere with foreign controls on our toplevel windows, therefore we always give back eventNotHandledErr
248 // for windows that we didn't create (like eg Scrollbars in a databrowser) , or for controls where we did not handle the
251 // This handler can also be called from app level where data (ie target window) may be null or a non wx window
253 wxWindow
* g_MacLastWindow
= NULL
;
255 static void SetupMouseEvent( wxMouseEvent
&wxevent
, wxMacCarbonEvent
&cEvent
)
257 UInt32 modifiers
= cEvent
.GetParameter
<UInt32
>(kEventParamKeyModifiers
, typeUInt32
) ;
258 Point screenMouseLocation
= cEvent
.GetParameter
<Point
>(kEventParamMouseLocation
) ;
260 // this parameter are not given for all events
261 EventMouseButton button
= 0 ;
262 UInt32 clickCount
= 0 ;
263 cEvent
.GetParameter
<EventMouseButton
>(kEventParamMouseButton
, typeMouseButton
, &button
) ;
264 cEvent
.GetParameter
<UInt32
>(kEventParamClickCount
, typeUInt32
, &clickCount
) ;
266 wxevent
.m_x
= screenMouseLocation
.h
;
267 wxevent
.m_y
= screenMouseLocation
.v
;
268 wxevent
.m_shiftDown
= modifiers
& shiftKey
;
269 wxevent
.m_controlDown
= modifiers
& controlKey
;
270 wxevent
.m_altDown
= modifiers
& optionKey
;
271 wxevent
.m_metaDown
= modifiers
& cmdKey
;
272 wxevent
.SetTimestamp( cEvent
.GetTicks() ) ;
273 // a control click is interpreted as a right click
274 if ( button
== kEventMouseButtonPrimary
&& (modifiers
& controlKey
) )
276 button
= kEventMouseButtonSecondary
;
279 // determinate the correct down state, wx does not want a 'down' for a mouseUp event, while mac delivers
281 if ( button
!= 0 && cEvent
.GetKind() != kEventMouseUp
)
285 case kEventMouseButtonPrimary
:
286 wxevent
.m_leftDown
= true ;
288 case kEventMouseButtonSecondary
:
289 wxevent
.m_rightDown
= true ;
291 case kEventMouseButtonTertiary
:
292 wxevent
.m_middleDown
= true ;
296 // determinate the correct click button
297 if ( button
== kEventMouseButtonSecondary
)
299 if (cEvent
.GetKind() == kEventMouseDown
)
300 wxevent
.SetEventType( clickCount
> 1 ? wxEVT_RIGHT_DCLICK
: wxEVT_RIGHT_DOWN
) ;
301 else if ( cEvent
.GetKind() == kEventMouseUp
)
302 wxevent
.SetEventType(wxEVT_RIGHT_UP
) ;
304 else if ( button
== kEventMouseButtonTertiary
)
306 if (cEvent
.GetKind() == kEventMouseDown
)
307 wxevent
.SetEventType(clickCount
> 1 ? wxEVT_MIDDLE_DCLICK
: wxEVT_MIDDLE_DOWN
) ;
308 else if ( cEvent
.GetKind() == kEventMouseUp
)
309 wxevent
.SetEventType(wxEVT_MIDDLE_UP
) ;
313 if (cEvent
.GetKind() == kEventMouseDown
)
314 wxevent
.SetEventType(clickCount
> 1 ? wxEVT_LEFT_DCLICK
: wxEVT_LEFT_DOWN
) ;
315 else if ( cEvent
.GetKind() == kEventMouseUp
)
316 wxevent
.SetEventType(wxEVT_LEFT_UP
) ;
317 else if ( cEvent
.GetKind() == kEventMouseWheelMoved
)
319 wxevent
.SetEventType(wxEVT_MOUSEWHEEL
) ;
321 // EventMouseWheelAxis axis = cEvent.GetParameter<EventMouseWheelAxis>(kEventParamMouseWheelAxis, typeMouseWheelAxis) ;
322 SInt32 delta
= cEvent
.GetParameter
<SInt32
>(kEventParamMouseWheelDelta
, typeLongInteger
) ;
324 wxevent
.m_wheelRotation
= delta
;
325 wxevent
.m_wheelDelta
= 1;
326 wxevent
.m_linesPerAction
= 1;
329 wxevent
.SetEventType(wxEVT_MOTION
) ;
333 ControlRef
wxMacFindSubControl( Point location
, ControlRef superControl
, ControlPartCode
*outPart
)
337 UInt16 childrenCount
= 0 ;
338 OSStatus err
= CountSubControls( superControl
, &childrenCount
) ;
339 if ( err
== errControlIsNotEmbedder
)
341 wxASSERT_MSG( err
== noErr
, wxT("Unexpected error when accessing subcontrols") ) ;
343 for ( UInt16 i
= childrenCount
; i
>=1 ; --i
)
345 ControlHandle sibling
;
346 err
= GetIndexedSubControl( superControl
, i
, & sibling
) ;
347 if ( err
== errControlIsNotEmbedder
)
350 wxASSERT_MSG( err
== noErr
, wxT("Unexpected error when accessing subcontrols") ) ;
351 if ( IsControlVisible( sibling
) )
354 GetControlBounds( sibling
, &r
) ;
355 if ( MacPtInRect( location
, &r
) )
357 ControlHandle child
= wxMacFindSubControl( location
, sibling
, outPart
) ;
362 *outPart
= TestControl( sibling
, location
) ;
372 ControlRef
wxMacFindControlUnderMouse( Point location
, WindowRef window
, ControlPartCode
*outPart
)
374 #if TARGET_API_MAC_OSX
375 if ( UMAGetSystemVersion() >= 0x1030 )
376 return FindControlUnderMouse( location
, window
, outPart
) ;
378 ControlRef rootControl
= NULL
;
379 verify_noerr( GetRootControl( window
, &rootControl
) ) ;
380 return wxMacFindSubControl( location
, rootControl
, outPart
) ;
383 pascal OSStatus
wxMacTopLevelMouseEventHandler( EventHandlerCallRef handler
, EventRef event
, void *data
)
386 OSStatus result
= eventNotHandledErr
;
388 wxMacCarbonEvent
cEvent( event
) ;
390 Point screenMouseLocation
= cEvent
.GetParameter
<Point
>(kEventParamMouseLocation
) ;
391 Point windowMouseLocation
= screenMouseLocation
;
394 short windowPart
= ::FindWindow(screenMouseLocation
, &window
);
396 wxWindow
* currentMouseWindow
= NULL
;
400 // calculate window relative coordinates
403 ::SetPort( UMAGetWindowPort(window
) ) ;
404 ::GlobalToLocal( &windowMouseLocation
) ;
407 if ( wxTheApp
->s_captureWindow
&& wxTheApp
->s_captureWindow
->MacGetTopLevelWindowRef() == (WXWindow
) window
&& windowPart
== inContent
)
409 currentMouseWindow
= wxTheApp
->s_captureWindow
;
411 else if ( (IsWindowActive(window
) && windowPart
== inContent
) )
413 ControlPartCode part
;
414 ControlRef control
= wxMacFindControlUnderMouse( windowMouseLocation
, window
, &part
) ;
416 currentMouseWindow
= (wxWindow
*) data
;
418 currentMouseWindow
= wxFindControlFromMacControl( control
) ;
422 wxMouseEvent
wxevent(wxEVT_LEFT_DOWN
);
423 SetupMouseEvent( wxevent
, cEvent
) ;
425 // handle all enter / leave events
427 if ( currentMouseWindow
!= g_MacLastWindow
)
429 if ( g_MacLastWindow
)
431 wxMouseEvent
eventleave(wxevent
);
432 eventleave
.SetEventType( wxEVT_LEAVE_WINDOW
);
433 g_MacLastWindow
->ScreenToClient( &eventleave
.m_x
, &eventleave
.m_y
);
434 eventleave
.SetEventObject( g_MacLastWindow
) ;
437 wxToolTip::RelayEvent( g_MacLastWindow
, eventleave
);
438 #endif // wxUSE_TOOLTIPS
439 g_MacLastWindow
->GetEventHandler()->ProcessEvent(eventleave
);
441 if ( currentMouseWindow
)
443 wxMouseEvent
evententer(wxevent
);
444 evententer
.SetEventType( wxEVT_ENTER_WINDOW
);
445 currentMouseWindow
->ScreenToClient( &evententer
.m_x
, &evententer
.m_y
);
446 evententer
.SetEventObject( currentMouseWindow
) ;
448 wxToolTip::RelayEvent( currentMouseWindow
, evententer
);
449 #endif // wxUSE_TOOLTIPS
450 currentMouseWindow
->GetEventHandler()->ProcessEvent(evententer
);
452 g_MacLastWindow
= currentMouseWindow
;
455 if ( windowPart
== inMenuBar
)
457 // special case menu bar, as we are having a low-level runloop we must do it ourselves
458 if ( cEvent
.GetKind() == kEventMouseDown
)
460 ::MenuSelect( screenMouseLocation
) ;
463 } // if ( windowPart == inMenuBar )
464 else if ( currentMouseWindow
)
466 currentMouseWindow
->ScreenToClient( &wxevent
.m_x
, &wxevent
.m_y
) ;
468 wxevent
.SetEventObject( currentMouseWindow
) ;
472 wxWindow
* cursorTarget
= currentMouseWindow
;
473 wxPoint
cursorPoint( wxevent
.m_x
, wxevent
.m_y
) ;
475 while( cursorTarget
&& !cursorTarget
->MacSetupCursor( cursorPoint
) )
477 cursorTarget
= cursorTarget
->GetParent() ;
479 cursorPoint
+= cursorTarget
->GetPosition() ;
484 if ( wxevent
.GetEventType() == wxEVT_LEFT_DOWN
)
486 // set focus to this window
487 if (currentMouseWindow
->AcceptsFocus() && wxWindow::FindFocus()!=currentMouseWindow
)
488 currentMouseWindow
->SetFocus();
491 // make tooltips current
494 if ( wxevent
.GetEventType() == wxEVT_MOTION
495 || wxevent
.GetEventType() == wxEVT_ENTER_WINDOW
496 || wxevent
.GetEventType() == wxEVT_LEAVE_WINDOW
)
497 wxToolTip::RelayEvent( currentMouseWindow
, wxevent
);
498 #endif // wxUSE_TOOLTIPS
499 if ( currentMouseWindow
->GetEventHandler()->ProcessEvent(wxevent
) )
503 ControlPartCode dummyPart
;
504 // if built-in find control is finding the wrong control (ie static box instead of overlaid
505 // button, we cannot let the standard handler do its job, but must handle manually
507 if ( ( cEvent
.GetKind() == kEventMouseDown
) &&
508 (FindControlUnderMouse(windowMouseLocation
, window
, &dummyPart
) !=
509 wxMacFindControlUnderMouse( windowMouseLocation
, window
, &dummyPart
) ) )
511 EventModifiers modifiers
= cEvent
.GetParameter
<EventModifiers
>(kEventParamKeyModifiers
, typeUInt32
) ;
512 HandleControlClick( (ControlRef
) currentMouseWindow
->GetHandle() , windowMouseLocation
,
513 modifiers
, (ControlActionUPP
) -1 ) ;
517 if ( cEvent
.GetKind() == kEventMouseUp
&& wxTheApp
->s_captureWindow
)
519 wxTheApp
->s_captureWindow
= NULL
;
522 } // else if ( currentMouseWindow )
526 static pascal OSStatus
wxMacTopLevelWindowEventHandler( EventHandlerCallRef handler
, EventRef event
, void *data
)
528 OSStatus result
= eventNotHandledErr
;
530 wxMacCarbonEvent
cEvent( event
) ;
532 // WindowRef windowRef = cEvent.GetParameter<WindowRef>(kEventParamDirectObject) ;
533 wxTopLevelWindowMac
* toplevelWindow
= (wxTopLevelWindowMac
*) data
;
535 switch( GetEventKind( event
) )
537 case kEventWindowActivated
:
539 toplevelWindow
->MacActivate( cEvent
.GetTicks() , true) ;
540 wxActivateEvent
wxevent(wxEVT_ACTIVATE
, true , toplevelWindow
->GetId());
541 wxevent
.SetTimestamp( cEvent
.GetTicks() ) ;
542 wxevent
.SetEventObject(toplevelWindow
);
543 toplevelWindow
->GetEventHandler()->ProcessEvent(wxevent
);
544 // we still sending an eventNotHandledErr in order to allow for default processing
547 case kEventWindowDeactivated
:
549 toplevelWindow
->MacActivate(cEvent
.GetTicks() , false) ;
550 wxActivateEvent
wxevent(wxEVT_ACTIVATE
, false , toplevelWindow
->GetId());
551 wxevent
.SetTimestamp( cEvent
.GetTicks() ) ;
552 wxevent
.SetEventObject(toplevelWindow
);
553 toplevelWindow
->GetEventHandler()->ProcessEvent(wxevent
);
554 // we still sending an eventNotHandledErr in order to allow for default processing
557 case kEventWindowShown
:
558 toplevelWindow
->Refresh() ;
561 case kEventWindowClose
:
562 toplevelWindow
->Close() ;
565 case kEventWindowBoundsChanged
:
567 UInt32 attributes
= cEvent
.GetParameter
<UInt32
>(kEventParamAttributes
,typeUInt32
) ;
568 Rect newRect
= cEvent
.GetParameter
<Rect
>(kEventParamCurrentBounds
) ;
569 wxRect
r( newRect
.left
, newRect
.top
, newRect
.right
- newRect
.left
, newRect
.bottom
- newRect
.top
) ;
570 if ( attributes
& kWindowBoundsChangeSizeChanged
)
572 // according to the other ports we handle this within the OS level
573 // resize event, not within a wxSizeEvent
574 wxFrame
*frame
= wxDynamicCast( toplevelWindow
, wxFrame
) ;
578 frame
->PositionStatusBar();
581 frame
->PositionToolBar();
585 wxSizeEvent
event( r
.GetSize() , toplevelWindow
->GetId() ) ;
586 event
.SetEventObject( toplevelWindow
) ;
588 toplevelWindow
->GetEventHandler()->ProcessEvent(event
) ;
590 if ( attributes
& kWindowBoundsChangeOriginChanged
)
592 wxMoveEvent
event( r
.GetLeftTop() , toplevelWindow
->GetId() ) ;
593 event
.SetEventObject( toplevelWindow
) ;
594 toplevelWindow
->GetEventHandler()->ProcessEvent(event
) ;
599 case kEventWindowBoundsChanging
:
601 UInt32 attributes
= cEvent
.GetParameter
<UInt32
>(kEventParamAttributes
,typeUInt32
) ;
602 Rect newRect
= cEvent
.GetParameter
<Rect
>(kEventParamCurrentBounds
) ;
604 if ( (attributes
& kWindowBoundsChangeSizeChanged
) || (attributes
& kWindowBoundsChangeOriginChanged
) )
606 // all (Mac) rects are in content area coordinates, all wxRects in structure coordinates
607 int left
, top
, right
, bottom
;
608 toplevelWindow
->MacGetContentAreaInset( left
, top
, right
, bottom
) ;
609 wxRect
r( newRect
.left
- left
, newRect
.top
- top
,
610 newRect
.right
- newRect
.left
+ left
+ right
, newRect
.bottom
- newRect
.top
+ top
+ bottom
) ;
611 // this is a EVT_SIZING not a EVT_SIZE type !
612 wxSizeEvent
wxevent( r
, toplevelWindow
->GetId() ) ;
613 wxevent
.SetEventObject( toplevelWindow
) ;
615 if ( toplevelWindow
->GetEventHandler()->ProcessEvent(wxevent
) )
616 adjustR
= wxevent
.GetRect() ;
618 if ( toplevelWindow
->GetMaxWidth() != -1 && adjustR
.GetWidth() > toplevelWindow
->GetMaxWidth() )
619 adjustR
.SetWidth( toplevelWindow
->GetMaxWidth() ) ;
620 if ( toplevelWindow
->GetMaxHeight() != -1 && adjustR
.GetHeight() > toplevelWindow
->GetMaxHeight() )
621 adjustR
.SetHeight( toplevelWindow
->GetMaxHeight() ) ;
622 if ( toplevelWindow
->GetMinWidth() != -1 && adjustR
.GetWidth() < toplevelWindow
->GetMinWidth() )
623 adjustR
.SetWidth( toplevelWindow
->GetMinWidth() ) ;
624 if ( toplevelWindow
->GetMinHeight() != -1 && adjustR
.GetHeight() < toplevelWindow
->GetMinHeight() )
625 adjustR
.SetHeight( toplevelWindow
->GetMinHeight() ) ;
626 Rect adjustedRect
= { adjustR
.y
+ top
, adjustR
.x
+ left
, adjustR
.y
+ adjustR
.height
- bottom
, adjustR
.x
+ adjustR
.width
- right
} ;
627 if ( !EqualRect( &newRect
, &adjustedRect
) )
628 cEvent
.SetParameter( kEventParamCurrentBounds
, &adjustedRect
) ;
640 pascal OSStatus
wxMacTopLevelEventHandler( EventHandlerCallRef handler
, EventRef event
, void *data
)
642 OSStatus result
= eventNotHandledErr
;
644 switch ( GetEventClass( event
) )
646 case kEventClassKeyboard
:
647 result
= KeyboardEventHandler( handler
, event
, data
) ;
649 case kEventClassTextInput
:
650 result
= TextInputEventHandler( handler
, event
, data
) ;
652 case kEventClassWindow
:
653 result
= wxMacTopLevelWindowEventHandler( handler
, event
, data
) ;
655 case kEventClassMouse
:
656 result
= wxMacTopLevelMouseEventHandler( handler
, event
, data
) ;
664 DEFINE_ONE_SHOT_HANDLER_GETTER( wxMacTopLevelEventHandler
)
666 // ---------------------------------------------------------------------------
667 // wxWindowMac utility functions
668 // ---------------------------------------------------------------------------
670 // Find an item given the Macintosh Window Reference
672 wxList
wxWinMacWindowList(wxKEY_INTEGER
);
673 wxTopLevelWindowMac
*wxFindWinFromMacWindow(WindowRef inWindowRef
)
675 wxNode
*node
= wxWinMacWindowList
.Find((long)inWindowRef
);
678 return (wxTopLevelWindowMac
*)node
->GetData();
681 void wxAssociateWinWithMacWindow(WindowRef inWindowRef
, wxTopLevelWindowMac
*win
) ;
682 void wxAssociateWinWithMacWindow(WindowRef inWindowRef
, wxTopLevelWindowMac
*win
)
684 // adding NULL WindowRef is (first) surely a result of an error and
685 // (secondly) breaks menu command processing
686 wxCHECK_RET( inWindowRef
!= (WindowRef
) NULL
, wxT("attempt to add a NULL WindowRef to window list") );
688 if ( !wxWinMacWindowList
.Find((long)inWindowRef
) )
689 wxWinMacWindowList
.Append((long)inWindowRef
, win
);
692 void wxRemoveMacWindowAssociation(wxTopLevelWindowMac
*win
) ;
693 void wxRemoveMacWindowAssociation(wxTopLevelWindowMac
*win
)
695 wxWinMacWindowList
.DeleteObject(win
);
699 // ----------------------------------------------------------------------------
700 // wxTopLevelWindowMac creation
701 // ----------------------------------------------------------------------------
703 wxTopLevelWindowMac
*wxTopLevelWindowMac::s_macDeactivateWindow
= NULL
;
705 void wxTopLevelWindowMac::Init()
708 m_maximizeOnShow
= FALSE
;
710 #if TARGET_API_MAC_OSX
711 m_macUsesCompositing
= TRUE
;
713 m_macUsesCompositing
= FALSE
;
715 m_macEventHandler
= NULL
;
718 class wxMacDeferredWindowDeleter
: public wxObject
721 wxMacDeferredWindowDeleter( WindowRef windowRef
)
723 m_macWindow
= windowRef
;
725 virtual ~wxMacDeferredWindowDeleter()
727 UMADisposeWindow( (WindowRef
) m_macWindow
) ;
730 WindowRef m_macWindow
;
733 bool wxTopLevelWindowMac::Create(wxWindow
*parent
,
735 const wxString
& title
,
739 const wxString
& name
)
744 m_windowStyle
= style
;
748 m_windowId
= id
== -1 ? NewControlId() : id
;
750 MacCreateRealWindow( title
, pos
, size
, MacRemoveBordersFromStyle(style
) , name
) ;
752 SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE
));
754 wxTopLevelWindows
.Append(this);
757 parent
->AddChild(this);
762 wxTopLevelWindowMac::~wxTopLevelWindowMac()
766 wxToolTip::NotifyWindowDelete(m_macWindow
) ;
767 wxPendingDelete
.Append( new wxMacDeferredWindowDeleter( (WindowRef
) m_macWindow
) ) ;
770 if ( m_macEventHandler
)
772 ::RemoveEventHandler((EventHandlerRef
) m_macEventHandler
);
773 m_macEventHandler
= NULL
;
776 wxRemoveMacWindowAssociation( this ) ;
778 if ( wxModelessWindows
.Find(this) )
779 wxModelessWindows
.DeleteObject(this);
783 // ----------------------------------------------------------------------------
784 // wxTopLevelWindowMac maximize/minimize
785 // ----------------------------------------------------------------------------
787 void wxTopLevelWindowMac::Maximize(bool maximize
)
789 wxMacPortStateHelper
help( (GrafPtr
) GetWindowPort( (WindowRef
) m_macWindow
) ) ;
790 wxMacWindowClipper
clip (this);
791 ZoomWindow( (WindowRef
)m_macWindow
, maximize
? inZoomOut
: inZoomIn
, false ) ;
794 GDHandle device = NULL ;
795 verify_noerr( GetWindowGreatestAreaDevice( (WindowRef) m_macWindow , kWindowContentRgn ,
797 verify_noerr( GetAvailableWindowPositioningBounds( GetMainDevice() , &r ) ) ;
802 Point pt = { 0, 0 } ;
803 SetPortWindowPort((WindowRef)m_macWindow) ;
804 LocalToGlobal( &pt ) ;
807 GetWindowPortBounds((WindowRef)m_macWindow, &tempRect ) ;
808 SetSize( pt.h , pt.v , tempRect.right-tempRect.left ,
809 tempRect.bottom-tempRect.top, wxSIZE_USE_EXISTING);
813 bool wxTopLevelWindowMac::IsMaximized() const
815 return IsWindowInStandardState( (WindowRef
)m_macWindow
, NULL
, NULL
) ;
818 void wxTopLevelWindowMac::Iconize(bool iconize
)
820 if ( IsWindowCollapsable((WindowRef
)m_macWindow
) )
821 CollapseWindow((WindowRef
)m_macWindow
, iconize
) ;
824 bool wxTopLevelWindowMac::IsIconized() const
826 return IsWindowCollapsed((WindowRef
)m_macWindow
) ;
829 void wxTopLevelWindowMac::Restore()
831 // not available on mac
834 // ----------------------------------------------------------------------------
835 // wxTopLevelWindowMac misc
836 // ----------------------------------------------------------------------------
838 wxPoint
wxTopLevelWindowMac::GetClientAreaOrigin() const
840 return wxPoint(0,0) ;
843 void wxTopLevelWindowMac::SetIcon(const wxIcon
& icon
)
846 wxTopLevelWindowBase::SetIcon(icon
);
849 void wxTopLevelWindowMac::MacSetBackgroundBrush( const wxBrush
&brush
)
851 wxTopLevelWindowBase::MacSetBackgroundBrush( brush
) ;
853 if ( m_macBackgroundBrush
.Ok() && m_macBackgroundBrush
.GetStyle() != wxTRANSPARENT
&& m_macBackgroundBrush
.MacGetBrushKind() == kwxMacBrushTheme
)
855 SetThemeWindowBackground( (WindowRef
) m_macWindow
, m_macBackgroundBrush
.MacGetTheme() , false ) ;
859 void wxTopLevelWindowMac::MacInstallTopLevelWindowEventHandler()
861 if ( m_macEventHandler
!= NULL
)
863 verify_noerr( ::RemoveEventHandler( (EventHandlerRef
) m_macEventHandler
) ) ;
865 InstallWindowEventHandler(MAC_WXHWND(m_macWindow
), GetwxMacTopLevelEventHandlerUPP(),
866 GetEventTypeCount(eventList
), eventList
, this, (EventHandlerRef
*)&m_macEventHandler
);
869 void wxTopLevelWindowMac::MacCreateRealWindow( const wxString
& title
,
873 const wxString
& name
)
875 OSStatus err
= noErr
;
877 m_windowStyle
= style
;
891 int w
= WidthDefault(size
.x
);
892 int h
= HeightDefault(size
.y
);
894 ::SetRect(&theBoundsRect
, x
, y
, x
+ w
, y
+ h
);
896 // translate the window attributes in the appropriate window class and attributes
898 WindowClass wclass
= 0;
899 WindowAttributes attr
= kWindowNoAttributes
;
901 if ( HasFlag( wxFRAME_TOOL_WINDOW
) )
904 HasFlag( wxMINIMIZE_BOX
) || HasFlag( wxMAXIMIZE_BOX
) ||
905 HasFlag( wxSYSTEM_MENU
) || HasFlag( wxCAPTION
) ||
906 HasFlag(wxTINY_CAPTION_HORIZ
) || HasFlag(wxTINY_CAPTION_VERT
)
909 wclass
= kFloatingWindowClass
;
910 if ( HasFlag(wxTINY_CAPTION_VERT
) )
912 attr
|= kWindowSideTitlebarAttribute
;
917 wclass
= kPlainWindowClass
;
920 else if ( HasFlag( wxCAPTION
) )
922 wclass
= kDocumentWindowClass
;
926 if ( HasFlag( wxMINIMIZE_BOX
) || HasFlag( wxMAXIMIZE_BOX
) ||
927 HasFlag( wxCLOSE_BOX
) || HasFlag( wxSYSTEM_MENU
) )
929 wclass
= kDocumentWindowClass
;
933 wclass
= kPlainWindowClass
;
937 if ( HasFlag( wxMINIMIZE_BOX
) )
939 attr
|= kWindowCollapseBoxAttribute
;
941 if ( HasFlag( wxMAXIMIZE_BOX
) )
943 attr
|= kWindowFullZoomAttribute
;
945 if ( HasFlag( wxRESIZE_BORDER
) )
947 attr
|= kWindowResizableAttribute
;
949 if ( HasFlag( wxCLOSE_BOX
) )
951 attr
|= kWindowCloseBoxAttribute
;
954 if (UMAGetSystemVersion() >= 0x1000)
956 // turn on live resizing (OS X only)
957 attr
|= kWindowLiveResizeAttribute
;
960 if (HasFlag(wxSTAY_ON_TOP
))
961 wclass
= kUtilityWindowClass
;
963 #if TARGET_API_MAC_OSX
964 attr
|= kWindowCompositingAttribute
;
967 if ( HasFlag(wxFRAME_SHAPED
) )
969 WindowDefSpec customWindowDefSpec
;
970 customWindowDefSpec
.defType
= kWindowDefProcPtr
;
971 customWindowDefSpec
.u
.defProc
= NewWindowDefUPP(wxShapedMacWindowDef
);
973 err
= ::CreateCustomWindow( &customWindowDefSpec
, wclass
,
974 attr
, &theBoundsRect
,
975 (WindowRef
*) &m_macWindow
);
979 err
= ::CreateNewWindow( wclass
, attr
, &theBoundsRect
, (WindowRef
*)&m_macWindow
) ;
982 wxCHECK_RET( err
== noErr
, wxT("Mac OS error when trying to create new window") );
984 // the create commands are only for content rect, so we have to set the size again as
986 SetWindowBounds( (WindowRef
) m_macWindow
, kWindowStructureRgn
, &theBoundsRect
) ;
988 wxAssociateWinWithMacWindow( (WindowRef
) m_macWindow
, this ) ;
989 UMASetWTitle( (WindowRef
) m_macWindow
, title
, m_font
.GetEncoding() ) ;
990 if ( m_macUsesCompositing
)
992 ::GetRootControl( (WindowRef
)m_macWindow
, (ControlRef
*)&m_macControl
) ;
996 ::CreateRootControl( (WindowRef
)m_macWindow
, (ControlRef
*)&m_macControl
) ;
998 // the root control level handleer
999 MacInstallEventHandler() ;
1001 // the frame window event handler
1002 InstallStandardEventHandler( GetWindowEventTarget(MAC_WXHWND(m_macWindow
)) ) ;
1003 MacInstallTopLevelWindowEventHandler() ;
1007 if ( HasFlag(wxFRAME_SHAPED
) )
1009 // default shape matches the window size
1010 wxRegion
rgn(0, 0, w
, h
);
1014 wxWindowCreateEvent
event(this);
1015 GetEventHandler()->ProcessEvent(event
);
1018 void wxTopLevelWindowMac::ClearBackground()
1020 wxWindow::ClearBackground() ;
1023 // Raise the window to the top of the Z order
1024 void wxTopLevelWindowMac::Raise()
1026 ::SelectWindow( (WindowRef
)m_macWindow
) ;
1029 // Lower the window to the bottom of the Z order
1030 void wxTopLevelWindowMac::Lower()
1032 ::SendBehind( (WindowRef
)m_macWindow
, NULL
) ;
1036 void wxTopLevelWindowMac::MacDelayedDeactivation(long timestamp
)
1038 if(s_macDeactivateWindow
)
1040 wxLogDebug(wxT("Doing delayed deactivation of %p"),s_macDeactivateWindow
);
1041 s_macDeactivateWindow
->MacActivate(timestamp
, false);
1045 void wxTopLevelWindowMac::MacActivate( long timestamp
, bool inIsActivating
)
1047 // wxLogDebug(wxT("TopLevel=%p::MacActivate"),this);
1049 if(s_macDeactivateWindow
==this)
1050 s_macDeactivateWindow
=NULL
;
1051 MacDelayedDeactivation(timestamp
);
1052 MacPropagateHiliteChanged() ;
1055 void wxTopLevelWindowMac::SetTitle(const wxString
& title
)
1057 wxWindow::SetTitle( title
) ;
1058 UMASetWTitle( (WindowRef
)m_macWindow
, title
, m_font
.GetEncoding() ) ;
1061 bool wxTopLevelWindowMac::Show(bool show
)
1063 if ( !wxTopLevelWindowBase::Show(show
) )
1068 #if wxUSE_SYSTEM_OPTIONS //code contributed by Ryan Wilcox December 18, 2003
1069 if ( (wxSystemOptions::HasOption(wxMAC_WINDOW_PLAIN_TRANSITION
) ) && ( wxSystemOptions::GetOptionInt( wxMAC_WINDOW_PLAIN_TRANSITION
) == 1) )
1071 ::ShowWindow( (WindowRef
)m_macWindow
);
1076 ::TransitionWindow((WindowRef
)m_macWindow
,kWindowZoomTransitionEffect
,kWindowShowTransitionAction
,nil
);
1078 ::SelectWindow( (WindowRef
)m_macWindow
) ;
1079 // as apps expect a size event to occur at this moment
1080 wxSizeEvent
event( GetSize() , m_windowId
);
1081 event
.SetEventObject(this);
1082 GetEventHandler()->ProcessEvent(event
);
1086 #if wxUSE_SYSTEM_OPTIONS
1087 if ( (wxSystemOptions::HasOption(wxMAC_WINDOW_PLAIN_TRANSITION
) ) && ( wxSystemOptions::GetOptionInt( wxMAC_WINDOW_PLAIN_TRANSITION
) == 1) )
1089 ::HideWindow((WindowRef
) m_macWindow
);
1094 ::TransitionWindow((WindowRef
)m_macWindow
,kWindowZoomTransitionEffect
,kWindowHideTransitionAction
,nil
);
1098 MacPropagateVisibilityChanged() ;
1103 // we are still using coordinates of the content view, todo switch to structure bounds
1105 void wxTopLevelWindowMac::MacGetContentAreaInset( int &left
, int &top
, int &right
, int &bottom
)
1109 GetWindowBounds( (WindowRef
) m_macWindow
, kWindowStructureRgn
, &structure
) ;
1110 GetWindowBounds( (WindowRef
) m_macWindow
, kWindowContentRgn
, &content
) ;
1112 left
= content
.left
- structure
.left
;
1113 top
= content
.top
- structure
.top
;
1114 right
= structure
.right
- content
.right
;
1115 bottom
= structure
.bottom
- content
.bottom
;
1118 void wxTopLevelWindowMac::DoMoveWindow(int x
, int y
, int width
, int height
)
1120 Rect bounds
= { y
, x
, y
+ height
, x
+ width
} ;
1121 verify_noerr(SetWindowBounds( (WindowRef
) m_macWindow
, kWindowStructureRgn
, &bounds
)) ;
1124 void wxTopLevelWindowMac::DoGetPosition( int *x
, int *y
) const
1127 verify_noerr(GetWindowBounds((WindowRef
) m_macWindow
, kWindowStructureRgn
, &bounds
)) ;
1128 if(x
) *x
= bounds
.left
;
1129 if(y
) *y
= bounds
.top
;
1131 void wxTopLevelWindowMac::DoGetSize( int *width
, int *height
) const
1134 verify_noerr(GetWindowBounds((WindowRef
) m_macWindow
, kWindowStructureRgn
, &bounds
)) ;
1135 if(width
) *width
= bounds
.right
- bounds
.left
;
1136 if(height
) *height
= bounds
.bottom
- bounds
.top
;
1139 void wxTopLevelWindowMac::DoGetClientSize( int *width
, int *height
) const
1142 verify_noerr(GetWindowBounds((WindowRef
) m_macWindow
, kWindowContentRgn
, &bounds
)) ;
1143 if(width
) *width
= bounds
.right
- bounds
.left
;
1144 if(height
) *height
= bounds
.bottom
- bounds
.top
;
1147 void wxTopLevelWindowMac::MacSetMetalAppearance( bool set
)
1149 #if TARGET_API_MAC_OSX
1151 GetWindowAttributes((WindowRef
) m_macWindow
, &attr
) ;
1152 wxASSERT_MSG( attr
& kWindowCompositingAttribute
,
1153 wxT("Cannot set metal appearance on a non-compositing window") ) ;
1155 MacChangeWindowAttributes( set
? kWindowMetalAttribute
: kWindowNoAttributes
,
1156 set
? kWindowNoAttributes
: kWindowMetalAttribute
) ;
1160 bool wxTopLevelWindowMac::MacGetMetalAppearance() const
1162 #if TARGET_API_MAC_OSX
1163 return MacGetWindowAttributes() & kWindowMetalAttribute
;
1169 void wxTopLevelWindowMac::MacChangeWindowAttributes( wxUint32 attributesToSet
, wxUint32 attributesToClear
)
1171 ChangeWindowAttributes ( (WindowRef
) m_macWindow
, attributesToSet
, attributesToClear
) ;
1174 wxUint32
wxTopLevelWindowMac::MacGetWindowAttributes() const
1177 GetWindowAttributes((WindowRef
) m_macWindow
, &attr
) ;
1181 // ---------------------------------------------------------------------------
1182 // Shape implementation
1183 // ---------------------------------------------------------------------------
1186 bool wxTopLevelWindowMac::SetShape(const wxRegion
& region
)
1188 wxCHECK_MSG( HasFlag(wxFRAME_SHAPED
), FALSE
,
1189 _T("Shaped windows must be created with the wxFRAME_SHAPED style."));
1191 // The empty region signifies that the shape should be removed from the
1193 if ( region
.IsEmpty() )
1195 wxSize sz
= GetClientSize();
1196 wxRegion
rgn(0, 0, sz
.x
, sz
.y
);
1197 return SetShape(rgn
);
1200 // Make a copy of the region
1201 RgnHandle shapeRegion
= NewRgn();
1202 CopyRgn( (RgnHandle
)region
.GetWXHRGN(), shapeRegion
);
1204 // Dispose of any shape region we may already have
1205 RgnHandle oldRgn
= (RgnHandle
)GetWRefCon( (WindowRef
)MacGetWindowRef() );
1209 // Save the region so we can use it later
1210 SetWRefCon((WindowRef
)MacGetWindowRef(), (SInt32
)shapeRegion
);
1212 // Tell the window manager that the window has changed shape
1213 ReshapeCustomWindow((WindowRef
)MacGetWindowRef());
1217 // ---------------------------------------------------------------------------
1218 // Support functions for shaped windows, based on Apple's CustomWindow sample at
1219 // http://developer.apple.com/samplecode/Sample_Code/Human_Interface_Toolbox/Mac_OS_High_Level_Toolbox/CustomWindow.htm
1220 // ---------------------------------------------------------------------------
1222 static void wxShapedMacWindowGetPos(WindowRef window
, Rect
* inRect
)
1224 GetWindowPortBounds(window
, inRect
);
1225 Point pt
= {inRect
->left
, inRect
->top
};
1226 SetPort((GrafPtr
) GetWindowPort(window
));
1229 inRect
->left
= pt
.h
;
1230 inRect
->bottom
+= pt
.v
;
1231 inRect
->right
+= pt
.h
;
1235 static SInt32
wxShapedMacWindowGetFeatures(WindowRef window
, SInt32 param
)
1237 /*------------------------------------------------------
1238 Define which options your custom window supports.
1239 --------------------------------------------------------*/
1240 //just enable everything for our demo
1241 *(OptionBits
*)param
=//kWindowCanGrow|
1243 //kWindowCanCollapse|
1244 //kWindowCanGetWindowRegion|
1245 //kWindowHasTitleBar|
1246 //kWindowSupportsDragHilite|
1247 kWindowCanDrawInCurrentPort
|
1248 //kWindowCanMeasureTitle|
1249 kWindowWantsDisposeAtProcessDeath
|
1250 kWindowSupportsSetGrowImageRegion
|
1251 kWindowDefSupportsColorGrafPort
;
1255 // The content region is left as a rectangle matching the window size, this is
1256 // so the origin in the paint event, and etc. still matches what the
1257 // programmer expects.
1258 static void wxShapedMacWindowContentRegion(WindowRef window
, RgnHandle rgn
)
1261 wxTopLevelWindowMac
* win
= wxFindWinFromMacWindow(window
);
1265 wxShapedMacWindowGetPos(window
, &r
) ;
1266 RectRgn( rgn
, &r
) ;
1270 // The structure region is set to the shape given to the SetShape method.
1271 static void wxShapedMacWindowStructureRegion(WindowRef window
, RgnHandle rgn
)
1273 RgnHandle cachedRegion
= (RgnHandle
) GetWRefCon(window
);
1279 wxShapedMacWindowGetPos(window
, &windowRect
); //how big is the window
1280 CopyRgn(cachedRegion
, rgn
); //make a copy of our cached region
1281 OffsetRgn(rgn
, windowRect
.left
, windowRect
.top
); // position it over window
1282 //MapRgn(rgn, &mMaskSize, &windowRect); //scale it to our actual window size
1288 static SInt32
wxShapedMacWindowGetRegion(WindowRef window
, SInt32 param
)
1290 GetWindowRegionPtr rgnRec
=(GetWindowRegionPtr
)param
;
1292 switch(rgnRec
->regionCode
)
1294 case kWindowStructureRgn
:
1295 wxShapedMacWindowStructureRegion(window
, rgnRec
->winRgn
);
1297 case kWindowContentRgn
:
1298 wxShapedMacWindowContentRegion(window
, rgnRec
->winRgn
);
1301 SetEmptyRgn(rgnRec
->winRgn
);
1308 static SInt32
wxShapedMacWindowHitTest(WindowRef window
,SInt32 param
)
1310 /*------------------------------------------------------
1311 Determine the region of the window which was hit
1312 --------------------------------------------------------*/
1314 static RgnHandle tempRgn
=nil
;
1319 SetPt(&hitPoint
,LoWord(param
),HiWord(param
));//get the point clicked
1321 //Mac OS 8.5 or later
1322 wxShapedMacWindowStructureRegion(window
, tempRgn
);
1323 if (PtInRgn(hitPoint
, tempRgn
)) //in window content region?
1326 return wNoHit
;//no significant area was hit.
1330 static pascal long wxShapedMacWindowDef(short varCode
, WindowRef window
, SInt16 message
, SInt32 param
)
1334 case kWindowMsgHitTest
:
1335 return wxShapedMacWindowHitTest(window
,param
);
1337 case kWindowMsgGetFeatures
:
1338 return wxShapedMacWindowGetFeatures(window
,param
);
1340 // kWindowMsgGetRegion is sent during CreateCustomWindow and ReshapeCustomWindow
1341 case kWindowMsgGetRegion
:
1342 return wxShapedMacWindowGetRegion(window
,param
);
1348 // ---------------------------------------------------------------------------