DockItem Class

Used to manage the icons for the REALbasic application and application windows in the Mac OS X dock.

Events

None

Properties

Graphics


Methods

ResetIcon

UpdateNow


More information available in parent classes: Object


Notes

The DockItem class is for Mac OS X only. It enables you to manipulate the dock item associated with your application or with the application's windows. To manipulate the application's dock icon, use the DockItem property of the Application class. To manipulate a window's dock icon, use the DockItem property of the Window class.

Use the methods of the Graphics class to modify the appearance of the icon. Since a Mac OS X icon is intended to be scaled automatically, you should design it as a 128x128 pixel icon.

The DockItem class has two methods, UpdateNow and ResetIcon. ResetIcon resets the icon to its original state. Call the UpdateNow method to redraw the icon. You can also use the ClearRect property of the Graphics class to start over from a blank icon. Anything you can do with a Graphics object you are able to do with the DockItem's Graphics property, such as drawing in a picture or using a Group2D.

The Graphics property may be Nil; it is non- Nil for a window only when a Mac OS X window has been minimized to the dock.


See Also

Application, Graphics, Window classes.