[wxWidgets.git] / include / wx / mac / uma.h

/////////////////////////////////////////////////////////////////////////////
// Name:        uma.h
// Purpose:     Universal MacOS API
// Author:      Stefan Csomor
// Modified by:
// Created:     03/02/99
// RCS-ID:      $Id: 
// Copyright:   (c) Stefan Csomor
// Licence:   	wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef H_UMA
#define H_UMA

// define this to be 1 if you have the 8.6 libs (weak linked)

#define UMA_USE_8_6 0 

#if TARGET_CARBON
#undef UMA_USE_8_6
#define UMA_USE_8_6 1 
#endif

#if defined(__POWERPC__) || defined(__APPLE__)
    #define UMA_USE_APPEARANCE 1
    #define UMA_USE_WINDOWMGR 1
    #if defined(__APPLE__)
        #include <Carbon/Carbon.h>
    #endif
#else
    #define UMA_USE_APPEARANCE 1
    #define UMA_USE_WINDOWMGR 0
#endif

#if UMA_USE_APPEARANCE == 0 
    #pragma error "wxMac needs appearance"
#endif

#if !UMA_USE_8_6 && UMA_USE_WINDOWMGR
#undef UMA_USE_WINDOWMGR
#define UMA_USE_WINDOWMGR 0
#endif

#if !TARGET_CARBON
//  this is now defined in the latest headers
//	typedef short MenuItemIndex  ;
#endif

void UMAInitToolbox( UInt16 inMoreMastersCalls) ;
void UMACleanupToolbox() ;
bool UMAHasAppearance() ;
long UMAGetAppearanceVersion() ;

// process manager

long UMAGetProcessMode() ;
bool UMAGetProcessModeDoesActivateOnFGSwitch() ;

// menu manager

void 			UMASetMenuTitle( MenuRef menu , StringPtr title ) ;
UInt32 			UMAMenuEvent( EventRecord *inEvent ) ;
void 			UMAEnableMenuItem( MenuRef inMenu , MenuItemIndex item ) ;	
void 			UMADisableMenuItem( MenuRef inMenu , MenuItemIndex item ) ;	
void			UMAAppendSubMenuItem( MenuRef menu , StringPtr label , SInt16 submenuid ) ;
void			UMAInsertSubMenuItem( MenuRef menu , StringPtr label , MenuItemIndex item , SInt16 submenuid  ) ;
void			UMAAppendMenuItem( MenuRef menu , StringPtr label , SInt16 key= 0, UInt8 modifiers = 0 ) ;
void			UMAInsertMenuItem( MenuRef menu , StringPtr label , MenuItemIndex item , SInt16 key = 0 , UInt8 modifiers = 0 ) ;
void			UMASetMenuItemText( MenuRef menu , MenuItemIndex item , StringPtr label ) ;

MenuRef			UMANewMenu( SInt16 menuid , StringPtr label ) ;
void 			UMADisposeMenu( MenuRef menu ) ;

// handling the menubar

void			UMADeleteMenu( SInt16 menuId ) ;
void			UMAInsertMenu( MenuRef insertMenu , SInt16 afterId ) ;
void			UMADrawMenuBar() ;

// quickdraw

void			UMAShowWatchCursor() ;
void			UMAShowArrowCursor() ;

#if PM_USE_SESSION_APIS
OSStatus		UMAPrOpen(PMPrintSession *macPrintPort) ;
OSStatus		UMAPrClose(PMPrintSession *macPrintPort) ;
#else
OSStatus		UMAPrOpen() ;
OSStatus		UMAPrClose() ;
#endif

// window manager

GrafPtr		UMAGetWindowPort( WindowRef inWindowRef ) ;
void		 	UMADisposeWindow( WindowRef inWindowRef ) ;
void 			UMASetWTitleC( WindowRef inWindowRef , const char *title ) ;
void 			UMAGetWTitleC( WindowRef inWindowRef , char *title ) ;

void 			UMADrawGrowIcon( WindowRef inWindowRef ) ;
void			UMAShowWindow( WindowRef inWindowRef ) ;
void			UMAHideWindow( WindowRef inWindowRef ) ;
void			UMAShowHide( WindowRef inWindowRef , Boolean show) ;
void 			UMASelectWindow( WindowRef inWindowRef ) ;
void			UMABringToFront( WindowRef inWindowRef ) ;
void			UMASendBehind( WindowRef inWindowRef , WindowRef behindWindow ) ;
void			UMACloseWindow(WindowRef inWindowRef) ;

// appearance manager

void 			UMADrawControl( ControlHandle inControl ) ;

void 			UMAEnableControl( ControlHandle inControl ) ;
void			UMADisableControl( ControlHandle inControl ) ;
void 			UMAActivateControl( ControlHandle inControl ) ;
void			UMADeactivateControl( ControlHandle inControl ) ;
void			UMAApplyThemeBackground			(ThemeBackgroundKind 	inKind,
								 const Rect *			bounds,
								 ThemeDrawState 		inState,
								 SInt16 				inDepth,
								 Boolean 				inColorDev);
void			UMASetThemeWindowBackground		(WindowRef 				inWindow,
								 ThemeBrush 			inBrush,
								 Boolean 				inUpdate)	;
ControlHandle UMANewControl(WindowPtr 				owningWindow,
								 const Rect *			boundsRect,
								 ConstStr255Param 		controlTitle,
								 Boolean 				initiallyVisible,
								 SInt16 				initialValue,
								 SInt16 				minimumValue,
								 SInt16 				maximumValue,
								 SInt16 				procID,
								 SInt32 				controlReference)	;
void UMADisposeControl (ControlHandle 			theControl)	;
void UMAHiliteControl	(ControlHandle 			theControl,
								 ControlPartCode 		hiliteState)	;
void UMAShowControl						(ControlHandle 			theControl)	;
void UMAHideControl						(ControlHandle 			theControl);
void UMASetControlVisibility			(ControlHandle 			inControl,
								 Boolean 				inIsVisible,
								 Boolean 				inDoDraw);

bool UMAIsControlActive					(ControlHandle 			inControl);
bool UMAIsControlVisible				(ControlHandle 			inControl);
void UMAActivateControl					(ControlHandle 			inControl);
void UMADeactivateControl				(ControlHandle 			inControl);

OSErr UMAGetBestControlRect				(ControlHandle 			inControl,
								 Rect *					outRect,
								 SInt16 *				outBaseLineOffset);
OSErr UMASetControlFontStyle				(ControlHandle 			inControl,
								 const ControlFontStyleRec * inStyle)	;


void UMAMoveControl( ControlHandle inControl , short x , short y ) ;
void UMASizeControl( ControlHandle inControl , short x , short y ) ;
// control hierarchy

OSErr UMACreateRootControl				(WindowPtr 				inWindow,
								 ControlHandle *		outControl) ;

OSErr UMAEmbedControl					(ControlHandle 			inControl,
								 ControlHandle 			inContainer);

// keyboard focus
OSErr UMASetKeyboardFocus				(WindowPtr 				inWindow,
								 ControlHandle 			inControl,
								 ControlFocusPart 		inPart)	;


// events

ControlPartCode UMAHandleControlClick				(ControlHandle 			inControl,
								 Point 					inWhere,
								 SInt16 				inModifiers,
								 ControlActionUPP 		inAction) ;
SInt16 UMAHandleControlKey				(ControlHandle 			inControl,
								 SInt16 				inKeyCode,
								 SInt16 				inCharCode,
								 SInt16 				inModifiers);
								 
void UMAIdleControls					(WindowPtr 				inWindow)	;

void UMAUpdateControls( WindowPtr inWindow , RgnHandle inRgn ) ;
OSErr UMAGetRootControl( WindowPtr inWindow , ControlHandle *outControl ) ;

// handling control data

OSErr UMASetControlData					(ControlHandle 			inControl,
								 ControlPartCode 		inPart,
								 ResType 				inTagName,
								 Size 					inSize,
								 Ptr 					inData)		;

OSErr UMAGetControlData					(ControlHandle 			inControl,
								 ControlPartCode 		inPart,
								 ResType 				inTagName,
								 Size 					inBufferSize,
								 Ptr 					outBuffer,
								 Size *					outActualSize) ;
OSErr UMAGetControlDataSize				(ControlHandle 			inControl,
								 ControlPartCode 		inPart,
								 ResType 				inTagName,
								 Size *					outMaxSize);


// system 8.0

short 		UMAFindWindow( Point inPoint , WindowRef *outWindow ) ;
OSStatus 	UMAGetWindowFeatures( WindowRef inWindowRef , UInt32 *outFeatures ) ;
OSStatus 	UMAGetWindowRegion( WindowRef inWindowRef , WindowRegionCode inRegionCode , RgnHandle ioWinRgn ) ;
OSStatus 	UMACollapseWindow( WindowRef inWindowRef , Boolean inCollapseIt ) ;
OSStatus 	UMACollapseAllWindows( Boolean inCollapseEm ) ;
Boolean 	UMAIsWindowCollapsed( WindowRef inWindowRef ) ;
Boolean UMAIsWindowCollapsable( WindowRef inWindowRef ) ;

// system 8.5

OSStatus 	UMACreateNewWindow( WindowClass windowClass , WindowAttributes attributes , const Rect *bounds,  WindowRef *outWindow ) ;
OSStatus 	UMAGetWindowClass( WindowRef inWindowRef , WindowClass *outWindowClass ) ;
OSStatus	UMAGetWindowAttributes( WindowRef inWindowRef , WindowAttributes *outAttributes ) ;

void 			UMAShowFloatingWindows() ;
void 			UMAHideFloatingWindows() ;
Boolean 	UMAAreFloatingWindowsVisible() ;
WindowRef UMAFrontWindow() ;
WindowRef UMAFrontNonFloatingWindow() ;

// floaters support

bool			UMAIsWindowFloating( WindowRef inWindow ) ;
bool			UMAIsWindowModal( WindowRef inWindow ) ;
WindowRef UMAGetActiveWindow() ;
WindowRef UMAGetActiveNonFloatingWindow() ;

void UMAHighlightAndActivateWindow( WindowRef inWindowRef , bool inActivate ) ;

#if !TARGET_CARBON
#define GetPortTextFont( p) ((p)->txFont )
#define GetPortTextSize( p) ((p)->txSize )
#define GetPortTextFace( p) ((p)->txFace )
#define GetPortTextMode( p) ((p)->txMode )
#define GetRegionBounds( r , b) ((*b) = (**r).rgnBBox)
#define GetPortBounds( p , b) ((*b) = p->portRect )
#define GetWindowPortBounds( p , b) ((*b) = p->portRect )
#define	GetPortVisibleRegion( p, r ) CopyRgn( p->visRgn , r )
#define GetQDGlobalsWhite( a ) (&((*a) = qd.white))
#define GetQDGlobalsBlack( a ) (&((*a) = qd.black))
#define GetQDGlobalsScreenBits( a ) (*a) = qd.screenBits
#define GetQDGlobalsArrow( a ) (&((*a) = qd.arrow))
#define GetControlBounds( c , b ) &((*b) = (**c).contrlRect )
#define GetPortBitMapForCopyBits( p ) ((BitMap*) &(((CGrafPtr)p)->portPixMap ))
#endif

// Appearance Drawing

OSStatus UMADrawThemePlacard( const Rect *inRect , ThemeDrawState inState ) ;

#endif
Commit	Line	Data
cfcc3671 UJ	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: uma.h
	3	// Purpose: Universal MacOS API
	4	// Author: Stefan Csomor
	5	// Modified by:
	6	// Created: 03/02/99
	7	// RCS-ID: $Id:
	8	// Copyright: (c) Stefan Csomor
292d1a2f	9	// Licence: wxWindows licence
cfcc3671 UJ	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef H_UMA
	13	#define H_UMA
	14
	15	// define this to be 1 if you have the 8.6 libs (weak linked)
	16
	17	#define UMA_USE_8_6 0
	18
5b781a67 SC	19	#if TARGET_CARBON
	20	#undef UMA_USE_8_6
	21	#define UMA_USE_8_6 1
	22	#endif
	23
03e11df5 GD	24	#if defined(__POWERPC__) \|\| defined(__APPLE__)
	25	#define UMA_USE_APPEARANCE 1
	26	#define UMA_USE_WINDOWMGR 1
	27	#if defined(__APPLE__)
	28	#include <Carbon/Carbon.h>
	29	#endif
05adb9d2	30	#else
fdaf613a	31	#define UMA_USE_APPEARANCE 1
03e11df5	32	#define UMA_USE_WINDOWMGR 0
05adb9d2	33	#endif
cfcc3671	34
fdaf613a SC	35	#if UMA_USE_APPEARANCE == 0
	36	#pragma error "wxMac needs appearance"
	37	#endif
	38
cfcc3671 UJ	39	#if !UMA_USE_8_6 && UMA_USE_WINDOWMGR
	40	#undef UMA_USE_WINDOWMGR
	41	#define UMA_USE_WINDOWMGR 0
	42	#endif
	43
	44	#if !TARGET_CARBON
05adb9d2 SC	45	// this is now defined in the latest headers
05adb9d2 SC	46	// typedef short MenuItemIndex ;
cfcc3671 UJ	47	#endif
	48
	49	void UMAInitToolbox( UInt16 inMoreMastersCalls) ;
5b781a67	50	void UMACleanupToolbox() ;
cfcc3671 UJ	51	bool UMAHasAppearance() ;
	52	long UMAGetAppearanceVersion() ;
	53
	54	// process manager
	55
	56	long UMAGetProcessMode() ;
	57	bool UMAGetProcessModeDoesActivateOnFGSwitch() ;
	58
	59	// menu manager
	60
05adb9d2 SC	61	void UMASetMenuTitle( MenuRef menu , StringPtr title ) ;
05adb9d2 SC	62	UInt32 UMAMenuEvent( EventRecord *inEvent ) ;
cfcc3671 UJ	63	void UMAEnableMenuItem( MenuRef inMenu , MenuItemIndex item ) ;
cfcc3671 UJ	64	void UMADisableMenuItem( MenuRef inMenu , MenuItemIndex item ) ;
05adb9d2 SC	65	void UMAAppendSubMenuItem( MenuRef menu , StringPtr label , SInt16 submenuid ) ;
	66	void UMAInsertSubMenuItem( MenuRef menu , StringPtr label , MenuItemIndex item , SInt16 submenuid ) ;
	67	void UMAAppendMenuItem( MenuRef menu , StringPtr label , SInt16 key= 0, UInt8 modifiers = 0 ) ;
	68	void UMAInsertMenuItem( MenuRef menu , StringPtr label , MenuItemIndex item , SInt16 key = 0 , UInt8 modifiers = 0 ) ;
	69	void UMASetMenuItemText( MenuRef menu , MenuItemIndex item , StringPtr label ) ;
	70
	71	MenuRef UMANewMenu( SInt16 menuid , StringPtr label ) ;
	72	void UMADisposeMenu( MenuRef menu ) ;
	73
	74	// handling the menubar
	75
	76	void UMADeleteMenu( SInt16 menuId ) ;
	77	void UMAInsertMenu( MenuRef insertMenu , SInt16 afterId ) ;
	78	void UMADrawMenuBar() ;
	79
cfcc3671 UJ	80	// quickdraw
	81
	82	void UMAShowWatchCursor() ;
	83	void UMAShowArrowCursor() ;
	84
0ab25937 GD	85	#if PM_USE_SESSION_APIS
	86	OSStatus UMAPrOpen(PMPrintSession *macPrintPort) ;
	87	OSStatus UMAPrClose(PMPrintSession *macPrintPort) ;
	88	#else
5b781a67 SC	89	OSStatus UMAPrOpen() ;
5b781a67 SC	90	OSStatus UMAPrClose() ;
0ab25937	91	#endif
05adb9d2	92
cfcc3671 UJ	93	// window manager
	94
	95	GrafPtr UMAGetWindowPort( WindowRef inWindowRef ) ;
	96	void UMADisposeWindow( WindowRef inWindowRef ) ;
	97	void UMASetWTitleC( WindowRef inWindowRef , const char *title ) ;
	98	void UMAGetWTitleC( WindowRef inWindowRef , char *title ) ;
	99
	100	void UMADrawGrowIcon( WindowRef inWindowRef ) ;
	101	void UMAShowWindow( WindowRef inWindowRef ) ;
	102	void UMAHideWindow( WindowRef inWindowRef ) ;
	103	void UMAShowHide( WindowRef inWindowRef , Boolean show) ;
	104	void UMASelectWindow( WindowRef inWindowRef ) ;
	105	void UMABringToFront( WindowRef inWindowRef ) ;
	106	void UMASendBehind( WindowRef inWindowRef , WindowRef behindWindow ) ;
	107	void UMACloseWindow(WindowRef inWindowRef) ;
	108
	109	// appearance manager
	110
	111	void UMADrawControl( ControlHandle inControl ) ;
	112
fdaf613a SC	113	void UMAEnableControl( ControlHandle inControl ) ;
fdaf613a SC	114	void UMADisableControl( ControlHandle inControl ) ;
cfcc3671 UJ	115	void UMAActivateControl( ControlHandle inControl ) ;
cfcc3671 UJ	116	void UMADeactivateControl( ControlHandle inControl ) ;
05adb9d2 SC	117	void UMAApplyThemeBackground (ThemeBackgroundKind inKind,
	118	const Rect * bounds,
	119	ThemeDrawState inState,
	120	SInt16 inDepth,
	121	Boolean inColorDev);
cfcc3671 UJ	122	void UMASetThemeWindowBackground (WindowRef inWindow,
	123	ThemeBrush inBrush,
	124	Boolean inUpdate) ;
	125	ControlHandle UMANewControl(WindowPtr owningWindow,
	126	const Rect * boundsRect,
	127	ConstStr255Param controlTitle,
	128	Boolean initiallyVisible,
	129	SInt16 initialValue,
	130	SInt16 minimumValue,
	131	SInt16 maximumValue,
	132	SInt16 procID,
	133	SInt32 controlReference) ;
	134	void UMADisposeControl (ControlHandle theControl) ;
	135	void UMAHiliteControl (ControlHandle theControl,
	136	ControlPartCode hiliteState) ;
	137	void UMAShowControl (ControlHandle theControl) ;
	138	void UMAHideControl (ControlHandle theControl);
	139	void UMASetControlVisibility (ControlHandle inControl,
	140	Boolean inIsVisible,
	141	Boolean inDoDraw);
	142
	143	bool UMAIsControlActive (ControlHandle inControl);
	144	bool UMAIsControlVisible (ControlHandle inControl);
	145	void UMAActivateControl (ControlHandle inControl);
	146	void UMADeactivateControl (ControlHandle inControl);
	147
	148	OSErr UMAGetBestControlRect (ControlHandle inControl,
	149	Rect * outRect,
	150	SInt16 * outBaseLineOffset);
	151	OSErr UMASetControlFontStyle (ControlHandle inControl,
	152	const ControlFontStyleRec * inStyle) ;
	153
	154
	155	void UMAMoveControl( ControlHandle inControl , short x , short y ) ;
	156	void UMASizeControl( ControlHandle inControl , short x , short y ) ;
	157	// control hierarchy
	158
	159	OSErr UMACreateRootControl (WindowPtr inWindow,
	160	ControlHandle * outControl) ;
	161
	162	OSErr UMAEmbedControl (ControlHandle inControl,
	163	ControlHandle inContainer);
	164
	165	// keyboard focus
	166	OSErr UMASetKeyboardFocus (WindowPtr inWindow,
	167	ControlHandle inControl,
	168	ControlFocusPart inPart) ;
	169
	170
	171	// events
	172
	173	ControlPartCode UMAHandleControlClick (ControlHandle inControl,
	174	Point inWhere,
	175	SInt16 inModifiers,
	176	ControlActionUPP inAction) ;
	177	SInt16 UMAHandleControlKey (ControlHandle inControl,
	178	SInt16 inKeyCode,
	179	SInt16 inCharCode,
	180	SInt16 inModifiers);
	181
	182	void UMAIdleControls (WindowPtr inWindow) ;
	183
	184	void UMAUpdateControls( WindowPtr inWindow , RgnHandle inRgn ) ;
	185	OSErr UMAGetRootControl( WindowPtr inWindow , ControlHandle *outControl ) ;
186
187	// handling control data
188
189	OSErr UMASetControlData (ControlHandle inControl,
190	ControlPartCode inPart,
191	ResType inTagName,
192	Size inSize,
193	Ptr inData) ;
194
195	OSErr UMAGetControlData (ControlHandle inControl,
196	ControlPartCode inPart,
197	ResType inTagName,
198	Size inBufferSize,
199	Ptr outBuffer,
200	Size * outActualSize) ;
201	OSErr UMAGetControlDataSize (ControlHandle inControl,
202	ControlPartCode inPart,
203	ResType inTagName,
204	Size * outMaxSize);
205
206
207	// system 8.0
208
209	short UMAFindWindow( Point inPoint , WindowRef *outWindow ) ;
210	OSStatus UMAGetWindowFeatures( WindowRef inWindowRef , UInt32 *outFeatures ) ;
211	OSStatus UMAGetWindowRegion( WindowRef inWindowRef , WindowRegionCode inRegionCode , RgnHandle ioWinRgn ) ;
212	OSStatus UMACollapseWindow( WindowRef inWindowRef , Boolean inCollapseIt ) ;
213	OSStatus UMACollapseAllWindows( Boolean inCollapseEm ) ;
214	Boolean UMAIsWindowCollapsed( WindowRef inWindowRef ) ;
215	Boolean UMAIsWindowCollapsable( WindowRef inWindowRef ) ;
216
217	// system 8.5
218
219	OSStatus UMACreateNewWindow( WindowClass windowClass , WindowAttributes attributes , const Rect bounds, WindowRef outWindow ) ;
220	OSStatus UMAGetWindowClass( WindowRef inWindowRef , WindowClass *outWindowClass ) ;
221	OSStatus UMAGetWindowAttributes( WindowRef inWindowRef , WindowAttributes *outAttributes ) ;
222
223	void UMAShowFloatingWindows() ;
224	void UMAHideFloatingWindows() ;
225	Boolean UMAAreFloatingWindowsVisible() ;
226	WindowRef UMAFrontWindow() ;
227	WindowRef UMAFrontNonFloatingWindow() ;
228
229	// floaters support
230
231	bool UMAIsWindowFloating( WindowRef inWindow ) ;
232	bool UMAIsWindowModal( WindowRef inWindow ) ;
233	WindowRef UMAGetActiveWindow() ;
234	WindowRef UMAGetActiveNonFloatingWindow() ;
235
236	void UMAHighlightAndActivateWindow( WindowRef inWindowRef , bool inActivate ) ;
237
05adb9d2 SC	238	#if !TARGET_CARBON
	239	#define GetPortTextFont( p) ((p)->txFont )
	240	#define GetPortTextSize( p) ((p)->txSize )
	241	#define GetPortTextFace( p) ((p)->txFace )
	242	#define GetPortTextMode( p) ((p)->txMode )
	243	#define GetRegionBounds( r , b) ((b) = (*r).rgnBBox)
	244	#define GetPortBounds( p , b) ((*b) = p->portRect )
	245	#define GetWindowPortBounds( p , b) ((*b) = p->portRect )
	246	#define GetPortVisibleRegion( p, r ) CopyRgn( p->visRgn , r )
	247	#define GetQDGlobalsWhite( a ) (&((*a) = qd.white))
	248	#define GetQDGlobalsBlack( a ) (&((*a) = qd.black))
	249	#define GetQDGlobalsScreenBits( a ) (*a) = qd.screenBits
	250	#define GetQDGlobalsArrow( a ) (&((*a) = qd.arrow))
c36f0244	251	#define GetControlBounds( c , b ) &((b) = (*c).contrlRect )
05adb9d2 SC	252	#define GetPortBitMapForCopyBits( p ) ((BitMap*) &(((CGrafPtr)p)->portPixMap ))
	253	#endif
	254
	255	// Appearance Drawing
	256
	257	OSStatus UMADrawThemePlacard( const Rect *inRect , ThemeDrawState inState ) ;
cfcc3671	258
03e11df5	259	#endif