CGWindowLevel.h File Reference

CoreGraphics window levels. More...

#include <CGBase.h>

Go to the source code of this file.

Macros
#define	kCGBaseWindowLevel    CGWindowLevelForKey(kCGBaseWindowLevelKey) /* LONG_MIN */
#define	kCGMinimumWindowLevel    CGWindowLevelForKey(kCGMinimumWindowLevelKey) /* (kCGBaseWindowLevel + 1) */
#define	kCGDesktopWindowLevel    CGWindowLevelForKey(kCGDesktopWindowLevelKey) /* kCGMinimumWindowLevel */
#define	kCGDesktopIconWindowLevel
#define	kCGBackstopMenuLevel    CGWindowLevelForKey(kCGBackstopMenuLevelKey) /* -20 */
#define	kCGNormalWindowLevel    CGWindowLevelForKey(kCGNormalWindowLevelKey) /* 0 */
#define	kCGFloatingWindowLevel    CGWindowLevelForKey(kCGFloatingWindowLevelKey) /* 3 */
#define	kCGTornOffMenuWindowLevel    CGWindowLevelForKey(kCGTornOffMenuWindowLevelKey) /* 3 */
#define	kCGDockWindowLevel   CGWindowLevelForKey(kCGDockWindowLevelKey) /* 10 */
#define	kCGMainMenuWindowLevel    CGWindowLevelForKey(kCGMainMenuWindowLevelKey) /* 20 */
#define	kCGStatusWindowLevel    CGWindowLevelForKey(kCGStatusWindowLevelKey) /* 21 */
#define	kCGModalPanelWindowLevel    CGWindowLevelForKey(kCGModalPanelWindowLevelKey) /* 8 */
#define	kCGPopUpMenuWindowLevel    CGWindowLevelForKey(kCGPopUpMenuWindowLevelKey) /* 101 */
#define	kCGDraggingWindowLevel    CGWindowLevelForKey(kCGDraggingWindowLevelKey) /* 500 */
#define	kCGScreenSaverWindowLevel    CGWindowLevelForKey(kCGScreenSaverWindowLevelKey) /* 1000 */
#define	kCGOverlayWindowLevel    CGWindowLevelForKey(kCGOverlayWindowLevelKey) /* 102 */
#define	kCGHelpWindowLevel
#define	kCGUtilityWindowLevel    CGWindowLevelForKey(kCGUtilityWindowLevelKey) /* 19 */
#define	kCGMaximumWindowLevel

Typedefs
typedef int32_t	CGWindowLevel
typedef int32_t	CGWindowLevelKey
typedef enum _CGCommonWindowLevelKey	_CGCommonWindowLevelKey

Enumerations
enum	_CGCommonWindowLevelKey {   kCGBaseWindowLevelKey = 0 , kCGMinimumWindowLevelKey = 1 , kCGDesktopWindowLevelKey = 2 , kCGBackstopMenuLevelKey = 3 ,   kCGNormalWindowLevelKey = 4 , kCGFloatingWindowLevelKey = 5 , kCGTornOffMenuWindowLevelKey = 6 , kCGDockWindowLevelKey = 7 ,   kCGMainMenuWindowLevelKey = 8 , kCGStatusWindowLevelKey = 9 , kCGModalPanelWindowLevelKey = 10 , kCGPopUpMenuWindowLevelKey = 11 ,   kCGDraggingWindowLevelKey = 12 , kCGScreenSaverWindowLevelKey = 13 , kCGMaximumWindowLevelKey = 14 , kCGOverlayWindowLevelKey = 15 ,   kCGHelpWindowLevelKey = 16 , kCGUtilityWindowLevelKey = 17 , kCGDesktopIconWindowLevelKey = 18 , kCGNumberOfWindowLevelKeys = 19 }
enum	{ kCGNumReservedWindowLevels = 16 }

Functions
CGWindowLevel	CGWindowLevelForKey (CGWindowLevelKey key)

Detailed Description

CoreGraphics window levels.

Introduced In: CoreGraphics-122 (Mac OS X 10.1)

Avaliable From: Universal Interfaces 3.4.1

Copyright: � 2000-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

kCGDesktopIconWindowLevel

#define kCGDesktopIconWindowLevel

Value:

  CGWindowLevelForKey(            \
      kCGDesktopIconWindowLevelKey) /* kCGMinimumWindowLevel + 20 */

kCGHelpWindowLevel

#define kCGHelpWindowLevel

Value:

                                                                       CGWindowLevelForKey(kCGHelpWindowLevelKey) /* 102 \
                                                                       */

kCGMaximumWindowLevel

#define kCGMaximumWindowLevel

Value:

  CGWindowLevelForKey(        \
      kCGMaximumWindowLevelKey) /* LONG_MAX - kCGNumReservedWindowLevels */

Typedef Documentation

CGWindowLevel

typedef int32_t CGWindowLevel

Windows may be assigned to a particular level. When assigned to a level, the window is ordered relative to all other windows in that level. Windows with a higher level are sorted in front of windows with a lower level.

A common set of window levels is defined here for use within higher level frameworks. The levels are accessed via a key and function, so that levels may be changed or adjusted in future releases without breaking binary compatability.

Function Documentation

CGWindowLevelForKey()

CGWindowLevel CGWindowLevelForKey

(

CGWindowLevelKey

key

)

CGWindowLevelForKey()

Availability:

Non-Carbon CFM: not available

Carbon Lib: not available

Mac OS X: in version 10.0 and later