CPPanel Class Reference

#import <CPPanel.h>

Inheritance diagram for CPPanel:

Instance Methods
(BOOL)	- becomesKeyOnlyIfNeeded
(BOOL)	- canBecomeKeyWindow
(BOOL)	- canBecomeMainWindow
(void)	- cancel:
(void)	- cancelOperation:
(BOOL)	- isFloatingPanel
(void)	- setBecomesKeyOnlyIfNeeded:
(void)	- setFloatingPanel:
(void)	- setWorksWhenModal:
(BOOL)	- worksWhenModal
Instance Methods inherited from CPWindow
(BOOL)	- acceptsFirstResponder
(BOOL)	- acceptsMouseMovedEvents
(void)	- addChildWindow:ordered:
(float)	- alphaValue
(void)	- animationDidEnd:
(CPTimeInterval)	- animationResizeTime:
(CPWindow)	- attachedSheet
(BOOL)	- autorecalculatesKeyViewLoop
(unsigned)	- autoresizingMask
(void)	- awakeFromCib
(CPColor)	- backgroundColor
(void)	- becomeKeyWindow
(void)	- becomeMainWindow
(void)	- center
(CPArray)	- childWindows
(void)	- close
(BOOL)	- containsPoint:
(CGRect)	- contentRectForFrameRect:
(CPView)	- contentView
(CGPoint)	- convertBaseToBridge:
(CGPoint)	- convertBaseToGlobal:
(CGPoint)	- convertBaseToPlatformWindow:
(CGPoint)	- convertBaseToScreen:
(CGPoint)	- convertBridgeToBase:
(CGPoint)	- convertGlobalToBase:
(CGPoint)	- convertPlatformWindowToBase:
(CGPoint)	- convertScreenToBase:
(CPButton)	- defaultButton
(CPButton)	- defaultButtonCell
(id)	- delegate
(void)	- deminiaturize:
(void)	- disableKeyEquivalentForDefaultButton
(void)	- disableKeyEquivalentForDefaultButtonCell
(void)	- doCommandBySelector:
(void)	- dragImage:at:offset:event:pasteboard:source:slideBack:
(void)	- dragView:at:offset:event:pasteboard:source:slideBack:
(void)	- enableKeyEquivalentForDefaultButton
(void)	- enableKeyEquivalentForDefaultButtonCell
(CPResponder)	- firstResponder
(CGRect)	- frame
(CGRect)	- frameRectForContentRect:
(BOOL)	- hasShadow
(BOOL)	- ignoresMouseEvents
(id)	- init
(CPView)	- initialFirstResponder
(id)	- initWithContentRect:styleMask:
(BOOL)	- isDocumentEdited
(BOOL)	- isDocumentSaving
(BOOL)	- isFullBridge
(BOOL)	- isFullPlatformWindow
(BOOL)	- isKeyWindow
(BOOL)	- isMainWindow
(void)	- isMiniaturized
(void)	- isMovable
(BOOL)	- isMovableByWindowBackground
(BOOL)	- isSheet
(BOOL)	- isVisible
(void)	- keyDown:
(int)	- level
(BOOL)	- makeFirstResponder:
(void)	- makeKeyAndOrderFront:
(void)	- makeKeyWindow
(void)	- makeMainWindow
(CGSize)	- maxSize
(void)	- miniaturize:
(CGSize)	- minSize
(void)	- orderBack:
(void)	- orderFront:
(void)	- orderOut:
(void)	- orderWindow:relativeTo:
(CPWindow)	- parentWindow
(void)	- performClose:
(BOOL)	- performKeyEquivalent:
(void)	- performMiniaturize:
(CPPlatformWindow)	- platformWindow
(void)	- recalculateKeyViewLoop
(void)	- redo:
(CPArray)	- registeredDraggedTypes
(void)	- registerForDraggedTypes:
(void)	- removeChildWindow:
(CPString)	- representedFilename
(CPURL)	- representedURL
(void)	- resignKeyWindow
(void)	- resignMainWindow
(CGSize)	- resizeIndicatorOffset
(void)	- resizeWithOldPlatformWindowSize:
(CPScreen)	- screen
(void)	- selectKeyViewFollowingView:
(void)	- selectKeyViewPrecedingView:
(void)	- selectNextKeyView:
(void)	- selectPreviousKeyView:
(void)	- sendEvent:
(void)	- setAcceptsMouseMovedEvents:
(void)	- setAlphaValue:
(void)	- setAutorecalculatesKeyViewLoop:
(void)	- setAutoresizingMask:
(void)	- setBackgroundColor:
(void)	- setContentView:
(void)	- setDefaultButton:
(void)	- setDefaultButtonCell:
(void)	- setDelegate:
(void)	- setDocumentEdited:
(void)	- setDocumentSaving:
(void)	- setFrame:
(void)	- setFrame:display:
(void)	- setFrame:display:animate:
(void)	- setFrameOrigin:
(void)	- setFrameSize:
(void)	- setFullBridge:
(void)	- setFullPlatformWindow:
(void)	- setHasShadow:
(void)	- setIgnoresMouseEvents:
(void)	- setInitialFirstResponder:
(void)	- setLevel:
(void)	- setMaxSize:
(void)	- setMinSize:
(void)	- setMovable:
(void)	- setMovableByWindowBackground:
(CPWindow)	- setParentWindow:
(void)	- setPlatformWindow:
(void)	- setRepresentedFilename:
(void)	- setRepresentedURL:
(void)	- setResizeIndicatorOffset:
(void)	- setShadowStyle:
(void)	- setShowsResizeIndicator:
(void)	- setTitle:
(void)	- setTitleWithRepresentedFilename:
(void)	- setToolbar:
(void)	- setValue:forKey:
(void)	- setWindowController:
(BOOL)	- showsResizeIndicator
(unsigned)	- styleMask
(CPString)	- title
(void)	- toggleToolbarShown:
(CPToolbar)	- toolbar
(void)	- undo:
(CPUndoManager)	- undoManager
(void)	- unregisterDraggedTypes
(CPWindowController)	- windowController
(int)	- windowNumber
Instance Methods inherited from CPResponder
(BOOL)	- becomeFirstResponder
(void)	- cursorUpdate:
(void)	- encodeWithCoder:
(void)	- flagsChanged:
(id)	- initWithCoder:
(void)	- insertBackTab:
(void)	- insertLineBreak:
(void)	- insertNewline:
(void)	- insertTab:
(void)	- insertText:
(void)	- interpretKeyEvents:
(void)	- keyUp:
(CPMenu)	- menu
(void)	- mouseDown:
(void)	- mouseDragged:
(void)	- mouseEntered:
(void)	- mouseExited:
(void)	- mouseMoved:
(void)	- mouseUp:
(CPResponder)	- nextResponder
(void)	- noResponderFor:
(BOOL)	- resignFirstResponder
(void)	- rightMouseDown:
(void)	- rightMouseUp:
(void)	- scrollWheel:
(void)	- setMenu:
(void)	- setNextResponder:
(BOOL)	- tryToPerform:with:
Instance Methods inherited from CPObject
(void)	- addObserver:forKeyPath:options:context:
(void)	- applyChange:toKeyPath:
(id)	- autorelease
(id)	- awakeAfterUsingCoder:
(void)	- bind:toObject:withKeyPath:options:
(Class)	- classForCoder
(Class)	- classForKeyedArchiver
(CPString)	- className
(id)	- copy
(void)	- dealloc
(CPString)	- description
(CPDictionary)	- dictionaryWithValuesForKeys:
(void)	- didChange:valuesAtIndexes:forKey:
(void)	- didChangeValueForKey:
(void)	- didChangeValueForKey:withSetMutation:usingObjects:
(void)	- doesNotRecognizeSelector:
(CPArray)	- exposedBindings
(id)	- forwardingTargetForSelector:
(void)	- forwardInvocation:
(unsigned)	- hash
(BOOL)	- implementsSelector:
(CPDictionary)	- infoForBinding:
(BOOL)	- isEqual:
(BOOL)	- isKindOfClass:
(BOOL)	- isMemberOfClass:
(BOOL)	- isProxy
(IMP)	- methodForSelector:
(CPMethodSignature)	- methodSignatureForSelector:
(id)	- mutableArrayValueForKey:
(id)	- mutableArrayValueForKeyPath:
(id)	- mutableCopy
(id)	- mutableSetValueForKey:
(id)	- mutableSetValueForKeyPath:
(id)	- performSelector:
(id)	- performSelector:withObject:
(void)	- performSelector:withObject:afterDelay:
(void)	- performSelector:withObject:afterDelay:inModes:
(id)	- performSelector:withObject:withObject:
(id)	- performSelector:withObjects:
(void)	- release
(void)	- removeObserver:forKeyPath:
(id)	- replacementObjectForArchiver:
(id)	- replacementObjectForCoder:
(id)	- replacementObjectForKeyedArchiver:
(BOOL)	- respondsToSelector:
(id)	- retain
(id)	- self
(void)	- setValue:forKeyPath:
(void)	- setValue:forUndefinedKey:
(void)	- setValuesForKeysWithDictionary:
(CPString)	- UID
(void)	- unbind:
(Class)	- valueClassForBinding:
(id)	- valueForKey:
(id)	- valueForKeyPath:
(id)	- valueForUndefinedKey:
(void)	- willChange:valuesAtIndexes:forKey:
(void)	- willChangeValueForKey:
(void)	- willChangeValueForKey:withSetMutation:usingObjects:

Additional Inherited Members
Class Methods inherited from CPWindow
(BOOL)	+ constrainWindowsToUsableScreen
(CGRect)	+ frameRectForContentRect:styleMask:
(int)	+ globalResizeStyle
(void)	+ setConstrainWindowsToUsableScreen:
(void)	+ setGlobalResizeStyle:
Class Methods inherited from CPObject
(BOOL)	+ accessInstanceVariablesDirectly
(id)	+ alloc
(id)	+ allocWithCoder:
(BOOL)	+ automaticallyNotifiesObserversForKey:
(void)	+ cancelPreviousPerformRequestsWithTarget:
(void)	+ cancelPreviousPerformRequestsWithTarget:selector:object:
(Class)	+ class
(BOOL)	+ conformsToProtocol:
(void)	+ exposeBinding:
(void)	+ initialize
(IMP)	+ instanceMethodForSelector:
(BOOL)	+ instancesImplementSelector:
(BOOL)	+ instancesRespondToSelector:
(BOOL)	+ isBindingExclusive:
(BOOL)	+ isSubclassOfClass:
(CPSet)	+ keyPathsForValuesAffectingValueForKey:
(void)	+ load
(id)	+ new
(void)	+ object:performSelector:withObject:afterDelay:inModes:
(void)	+ setVersion:
(Class)	+ superclass
(int)	+ version

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 2 of file CPPanel.h.

Method Documentation

becomesKeyOnlyIfNeeded()

- (BOOL) becomesKeyOnlyIfNeeded

implementation

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

Reimplemented from CPWindow.

Definition at line 82 of file CPPanel.j.

canBecomeKeyWindow()

- (BOOL) canBecomeKeyWindow

implementation

Determines if the window can become the key window.

Returns

YES means the window can become the key window.

Reimplemented from CPWindow.

Definition at line 115 of file CPPanel.j.

canBecomeMainWindow()

- (BOOL) canBecomeMainWindow

implementation

Returns YES if the window can become the main window.

Reimplemented from CPWindow.

Definition at line 110 of file CPPanel.j.

cancel:()

- (void) cancel: (id)  sender

implementation

Definition at line 135 of file CPPanel.j.

cancelOperation:()

- (void) cancelOperation: (id)  sender

implementation

Definition at line 127 of file CPPanel.j.

isFloatingPanel()

- (BOOL) isFloatingPanel

implementation

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

Definition at line 63 of file CPPanel.j.

setBecomesKeyOnlyIfNeeded:()

- (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 91 of file CPPanel.j.

setFloatingPanel:()

- (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 73 of file CPPanel.j.

setWorksWhenModal:()

- (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 105 of file CPPanel.j.

worksWhenModal()

- (BOOL) worksWhenModal

implementation

Returns YES if the receiver is able to receive input events even when a modal session is active.

Reimplemented from CPWindow.

Reimplemented in CPFontPanel.

Definition at line 96 of file CPPanel.j.

---

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

• AppKit/CPPanel.h
• AppKit/CPPanel.j