API  0.9.7
 All Classes Files Functions Variables Macros Groups Pages
CPPanel Class Reference

#import <CPPanel.h>

+ Inheritance diagram for CPPanel:

Instance Methods

(BOOL) - becomesKeyOnlyIfNeeded
(BOOL) - canBecomeKeyWindow
(BOOL) - canBecomeMainWindow
(BOOL) - isFloatingPanel
(void) - setBecomesKeyOnlyIfNeeded:
(void) - setFloatingPanel:
(void) - setWorksWhenModal:
(BOOL) - worksWhenModal

Detailed Description

The CPPanel class defines objects that manage the panels of the Cappuccino user interface. A panel is a window that serves an auxiliary function within an application. It generally displays controls that the user can act on to give instructions to the application or to modify the contents of a standard window.</p>

Panels behave differently from standard windows in only a small number of ways, but the ways are important to the user interface:

  • Panels can assume key window status but not main window status. (The key window receives keyboard events. The main window is the primary focus of user actions; it might contain the document the user is working on, for example.)

To aid in their auxiliary role, panels can be assigned special behaviors:

  • A panel can be precluded from becoming the key window until the user makes a selection (makes some view in the panel the first responder) indicating an intention to begin typing. This prevents key window status from shifting to the panel unnecessarily.
  • Palettes and similar panels can be made to float above standard windows and other panels. This prevents them from being covered and keeps them readily available to the user.
  • A panel can be made to work even when there's an attention panel on-screen. This permits actions within the panel to affect the attention panel.

Definition at line 2 of file CPPanel.h.

Method Documentation

- (BOOL) becomesKeyOnlyIfNeeded

Returns YES if the window only becomes key if needed. NO means it behaves just like other windows.

Definition at line 83 of file CPPanel.j.

- (BOOL) canBecomeKeyWindow

Definition at line 116 of file CPPanel.j.

- (BOOL) canBecomeMainWindow

Definition at line 111 of file CPPanel.j.

- (BOOL) isFloatingPanel

Returns YES if the receiver is a floating panel (like a palette).

Definition at line 64 of file CPPanel.j.

- (void) setBecomesKeyOnlyIfNeeded: (BOOL)  shouldBecomeKeyOnlyIfNeeded

Sets whether the the window becomes key only if needed.

shouldBecomeKeyOnlyIfNeededYES makes the window become key only if needed

Definition at line 92 of file CPPanel.j.

- (void) setFloatingPanel: (BOOL)  isFloatingPanel

Sets the receiver to be a floating panel. YES makes the window a floating panel. NO makes it a normal window.

isFloatingPanelspecifies whether to make it floating

Definition at line 74 of file CPPanel.j.

- (void) setWorksWhenModal: (BOOL)  shouldWorkWhenModal

Sets whether this window can receive input while another window is running modally.

shouldWorkWhenModalwhether to receive input while another window is modal

Definition at line 106 of file CPPanel.j.

- (BOOL) worksWhenModal

Definition at line 97 of file CPPanel.j.

The documentation for this class was generated from the following files: