CPPanel Class Reference
[AppKit]
List of all members.
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.
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 56 of file CPPanel.j.
Member Function Documentation
- (BOOL) becomesKeyOnlyIfNeeded |
|
|
|
[implementation] |
Returns YES
if the window only becomes key if needed. NO
means it behaves just like other windows.
Definition at line 84 of file CPPanel.j.
- (BOOL) canBecomeMainWindow |
|
|
|
[implementation] |
- (BOOL) isFloatingPanel |
|
|
|
[implementation] |
Returns YES
if the receiver is a floating panel (like a palette).
Definition at line 65 of file CPPanel.j.
- (void) setBecomesKeyOnlyIfNeeded: |
|
(BOOL) |
shouldBecomeKeyOnlyIfNeeded |
|
[implementation] |
Sets whether the the window becomes key only if needed.
- Parameters:
-
| shouldBecomeKeyOnlyIfNeeded | YES makes the window become key only if needed |
Definition at line 93 of file CPPanel.j.
- (void) setFloatingPanel: |
|
(BOOL) |
isFloatingPanel |
|
[implementation] |
Sets the receiver to be a floating panel. YES
makes the window a floating panel. NO
makes it a normal window.
- Parameters:
-
| isFloatingPanel | specifies whether to make it floating |
Definition at line 75 of file CPPanel.j.
- (void) setWorksWhenModal: |
|
(BOOL) |
shouldWorkWhenModal |
|
[implementation] |
Sets whether this window can receive input while another window is running modally.
- Parameters:
-
| shouldWorkWhenModal | whether to receive input while another window is modal |
Definition at line 107 of file CPPanel.j.
- (BOOL) worksWhenModal |
|
|
|
[implementation] |
The documentation for this class was generated from the following file: