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

#import <CPControl.h>

+ Inheritance diagram for CPControl:

Instance Methods

(BOOL) - acceptsFirstMouse:
 
(SEL) - action
 
(CPTextAlignment) - alignment
 
(BOOL) - continueTracking:at:
 
(double) - doubleValue
 
(void) - encodeWithCoder:
 
(float) - floatValue
 
(CPFont- font
 
(CPFormatter- formatter
 
(void) - highlight:
 
(CPCellImagePosition) - imagePosition
 
(CPUInteger) - imageScaling
 
(id) - initWithCoder:
 
(id) - initWithFrame:
 
(int) - integerValue
 
(int) - intValue
 
(BOOL) - isContinuous
 
(BOOL) - isEnabled
 
(BOOL) - isHighlighted
 
(CPLineBreakMode) - lineBreakMode
 
(void) - mouseDown:
 
(unsigned) - mouseDownFlags
 
(void) - mouseEntered:
 
(void) - mouseExited:
 
(CPInteger) - nextState
 
(id) - objectValue
 
(void) - performClick:
 
(BOOL) - sendAction:to:
 
(int) - sendActionOn:
 
(BOOL) - sendsActionOnEndEditing
 
(void) - setAction:
 
(void) - setAlignment:
 
(void) - setContinuous:
 
(void) - setDoubleValue:
 
(void) - setEnabled:
 
(void) - setFloatValue:
 
(void) - setFont:
 
(void) - setFormatter:
 
(void) - setHighlighted:
 
(void) - setImagePosition:
 
(void) - setImageScaling:
 
(void) - setIntegerValue:
 
(void) - setIntValue:
 
(void) - setLineBreakMode:
 
(void) - setObjectValue:
 
(void) - setSendsActionOnEndEditing:
 
(void) - setState:
 
(void) - setStringValue:
 
(void) - setTarget:
 
(void) - setTextColor:
 
(void) - setTextShadowColor:
 
(void) - setTextShadowOffset:
 
(void) - setVerticalAlignment:
 
(BOOL) - startTrackingAt:
 
(void) - stopTracking:at:mouseIsUp:
 
(CPString- stringValue
 
(void) - takeDoubleValueFrom:
 
(void) - takeFloatValueFrom:
 
(void) - takeIntegerValueFrom:
 
(void) - takeIntValueFrom:
 
(void) - takeObjectValueFrom:
 
(void) - takeStringValueFrom:
 
(id) - target
 
(CPColor- textColor
 
(void) - textDidBeginEditing:
 
(void) - textDidChange:
 
(void) - textDidEndEditing:
 
(CPColor- textShadowColor
 
(CGSize) - textShadowOffset
 
(void) - trackMouse:
 
(BOOL) - tracksMouseOutsideOfFrame
 
(void) - unhighlightButtonTimerDidFinish:
 
(CPTextVerticalAlignment) - verticalAlignment
 

Class Methods

(void) + initialize
 
(CPDictionary+ themeAttributes
 

Detailed Description

CPControl is an abstract superclass used to implement user interface elements. As a subclass of CPView and CPResponder it has the ability to handle screen drawing and handling user input.

Definition at line 2 of file CPControl.h.

Method Documentation

- (BOOL) acceptsFirstMouse: (CPEvent anEvent
implementation

Enabled controls accept first mouse by default.

Definition at line 395 of file CPControl.j.

- (SEL) action
implementation

Returns the receiver's target action.

Definition at line 194 of file CPControl.j.

- (CPTextAlignment) alignment
implementation

Returns the text alignment of the control.

Definition at line 688 of file CPControl.j.

- (BOOL) continueTracking: (CGPoint)  lastPoint
at: (CGPoint)  aPoint 
implementation

Reimplemented in CPSlider.

Definition at line 379 of file CPControl.j.

- (double) doubleValue
implementation

Returns the receiver's double value.

Definition at line 466 of file CPControl.j.

- (void) encodeWithCoder: (CPCoder aCoder
implementation
- (float) floatValue
implementation

Returns the receiver's float value.

Definition at line 449 of file CPControl.j.

- (CPFont) font
implementation

Returns the font of the control.

Definition at line 803 of file CPControl.j.

- (CPFormatter) formatter
implementation

Synthesized accessor method.

Provided by category CPControl(CPSynthesizedAccessors).

Definition at line 1053 of file CPControl.j.

- (void) highlight: (BOOL)  shouldHighlight
implementation

Highlights the receiver.

Parameters
BOOL- YES if the receiver should be highlighted, otherwise NO.

Definition at line 884 of file CPControl.j.

- (CPCellImagePosition) imagePosition
implementation

Returns the image position of the receiver.

Definition at line 829 of file CPControl.j.

- (CPUInteger) imageScaling
implementation

Returns the image scaling of the control.

Reimplemented in CPImageView.

Definition at line 852 of file CPControl.j.

+ (void) initialize
implementation

Reimplemented in CPImageView.

Definition at line 122 of file CPControl.j.

- (id) initWithCoder: (CPCoder aCoder
implementation
- (id) initWithFrame: (CGRect)  aFrame
implementation
- (int) integerValue
implementation

Returns the receiver's int value.

Definition at line 500 of file CPControl.j.

- (int) intValue
implementation

Returns the receiver's int value.

Definition at line 483 of file CPControl.j.

- (BOOL) isContinuous
implementation

Returns whether the control can continuously send its action messages.

Reimplemented in CPSlider.

Definition at line 245 of file CPControl.j.

- (BOOL) isEnabled
implementation

Returns YES if the receiver is enabled, otherwise NO.

Definition at line 874 of file CPControl.j.

- (BOOL) isHighlighted
implementation

Returns YES if the control is highlighted, otherwise NO.

Definition at line 905 of file CPControl.j.

- (CPLineBreakMode) lineBreakMode
implementation

Returns the line break mode of the control.

Definition at line 735 of file CPControl.j.

- (void) mouseDown: (CPEvent anEvent
implementation
- (unsigned) mouseDownFlags
implementation

Returns the mask of modifier keys held down when the user clicked.

Definition at line 367 of file CPControl.j.

- (void) mouseEntered: (CPEvent anEvent
implementation

Reimplemented in CPScroller.

Definition at line 408 of file CPControl.j.

- (void) mouseExited: (CPEvent anEvent
implementation

Reimplemented in CPScroller.

Definition at line 416 of file CPControl.j.

- (CPInteger) nextState
implementation

Reimplemented in CPRadio, and CPButton.

Definition at line 323 of file CPControl.j.

- (id) objectValue
implementation

Returns the receiver's object value.

Reimplemented in CPTokenField, and CPPopUpButton.

Definition at line 430 of file CPControl.j.

- (void) performClick: (id)  sender
implementation

Perform a click on the receiver.

Parameters
sender- The sender object

Reimplemented in CPButton.

Definition at line 333 of file CPControl.j.

- (BOOL) sendAction: (SEL)  anAction
to: (id)  anObject 
implementation

Causes anAction to be sent to anObject.

Parameters
anActionthe action to send
anObjectthe object to which the action will be sent

Reimplemented in CPRadio, CPTokenField, and CPComboBox.

Definition at line 223 of file CPControl.j.

- (int) sendActionOn: (int)  mask
implementation

Definition at line 233 of file CPControl.j.

- (BOOL) sendsActionOnEndEditing
implementation

Synthesized accessor method.

Provided by category CPControl(CPSynthesizedAccessors).

Definition at line 1069 of file CPControl.j.

- (void) setAction: (SEL)  anAction
implementation

Sets the receiver's target action.

Parameters
anActionSets the action message that gets sent to the target.

Definition at line 186 of file CPControl.j.

- (void) setAlignment: (CPTextAlignment)  alignment
implementation

Sets the text alignment of the control.

CPLeftTextAlignment
CPCenterTextAlignment
CPRightTextAlignment
CPJustifiedTextAlignment
CPNaturalTextAlignment

Reimplemented in CPComboBox.

Definition at line 680 of file CPControl.j.

- (void) setContinuous: (BOOL)  flag
implementation

Sets whether the cell can continuously send its action messages.

Reimplemented in CPSlider.

Definition at line 254 of file CPControl.j.

- (void) setDoubleValue: (double)  anObject
implementation

Sets the receiver's double value.

Reimplemented in CPStepper.

Definition at line 475 of file CPControl.j.

- (void) setEnabled: (BOOL)  isEnabled
implementation

Sets the enabled status of the control. Controls that are not enabled can not be used by the user and obtain the CPThemeStateDisabled theme state.

Parameters
BOOL- YES if the control should be enabled, otherwise NO.

Reimplemented in CPTokenField, and CPStepper.

Definition at line 863 of file CPControl.j.

- (void) setFloatValue: (float)  aValue
implementation

Sets the receiver's float value.

Definition at line 458 of file CPControl.j.

- (void) setFont: (CPFont aFont
implementation

Sets the font of the control.

Reimplemented in CPComboBox, and CPSegmentedControl.

Definition at line 795 of file CPControl.j.

- (void) setFormatter: (CPFormatter aValue
implementation

Synthesized accessor method.

Provided by category CPControl(CPSynthesizedAccessors).

Definition at line 1061 of file CPControl.j.

- (void) setHighlighted: (BOOL)  isHighlighted
implementation

Highlights the receiver.

Parameters
BOOL- YES if the receiver should be highlighted, otherwise NO.

Definition at line 894 of file CPControl.j.

- (void) setImagePosition: (CPCellImagePosition)  position
implementation

Sets the image position of the control.

CPNoImage
CPImageOnly
CPImageLeft
CPImageRight
CPImageBelow
CPImageAbove
CPImageOverlaps

Definition at line 821 of file CPControl.j.

- (void) setImageScaling: (CPImageScaling)  scaling
implementation

Sets the image scaling of the control.

CPImageScaleProportionallyDown
CPImageScaleAxesIndependently
CPImageScaleNone
CPImageScaleProportionallyUpOrDown

Reimplemented in CPImageView.

Definition at line 844 of file CPControl.j.

- (void) setIntegerValue: (int)  anObject
implementation

Sets the receiver's int value.

Definition at line 509 of file CPControl.j.

- (void) setIntValue: (int)  anObject
implementation

Sets the receiver's int value.

Definition at line 492 of file CPControl.j.

- (void) setLineBreakMode: (CPLineBreakMode)  mode
implementation

Sets the line break mode of the receiver.

CPLineBreakByWordWrapping
CPLineBreakByCharWrapping
CPLineBreakByClipping
CPLineBreakByTruncatingHead
CPLineBreakByTruncatingTail
CPLineBreakByTruncatingMiddle

Definition at line 727 of file CPControl.j.

- (void) setObjectValue: (id)  anObject
implementation

Sets the receiver's object value.

Reimplemented in CPRadio, CPButton, CPScroller, CPTokenField, CPComboBox, CPSlider, and CPPopUpButton.

Definition at line 438 of file CPControl.j.

- (void) setSendsActionOnEndEditing: (BOOL)  aValue
implementation

Synthesized accessor method.

Provided by category CPControl(CPSynthesizedAccessors).

Definition at line 1077 of file CPControl.j.

- (void) setState: (CPInteger)  state
implementation

Reimplemented in CPDisclosureButton, and CPButton.

Definition at line 319 of file CPControl.j.

- (void) setStringValue: (CPString aString
implementation

Sets the receiver's string value.

Definition at line 533 of file CPControl.j.

- (void) setTarget: (id)  aTarget
implementation

Sets the receiver's target. The target receives action messages from the receiver.

Parameters
aTargetthe object that will receive the message specified by action

Definition at line 204 of file CPControl.j.

- (void) setTextColor: (CPColor aColor
implementation

Sets the text color of the receiver.

Parameters
aColor- A CPColor object.

Definition at line 745 of file CPControl.j.

- (void) setTextShadowColor: (CPColor aColor
implementation

Sets the shadow color of the text for the receiver.

Definition at line 761 of file CPControl.j.

- (void) setTextShadowOffset: (CGSize)  offset
implementation

Sets the shadow offset for the text.

Parameters
offset- a CGSize with the x and y offsets.

Definition at line 779 of file CPControl.j.

- (void) setVerticalAlignment: (CPTextVerticalAlignment)  alignment
implementation

Set the vertical text alignment of the control.

CPTopVerticalTextAlignment
CPCenterVerticalTextAlignment
CPBottomVerticalTextAlignment

Definition at line 702 of file CPControl.j.

- (BOOL) startTrackingAt: (CGPoint)  aPoint
implementation

Reimplemented in CPRadio, CPButton, CPSlider, and CPCheckBox.

Definition at line 372 of file CPControl.j.

- (void) stopTracking: (CGPoint)  lastPoint
at: (CGPoint)  aPoint
mouseIsUp: (BOOL)  mouseIsUp 
implementation

Reimplemented in CPButton, CPSlider, and CPColorWell.

Definition at line 384 of file CPControl.j.

- (CPString) stringValue
implementation

Returns the receiver's string value.

Reimplemented in CPTokenField.

Definition at line 517 of file CPControl.j.

- (void) takeDoubleValueFrom: (id)  sender
implementation

Definition at line 561 of file CPControl.j.

- (void) takeFloatValueFrom: (id)  sender
implementation

Definition at line 568 of file CPControl.j.

- (void) takeIntegerValueFrom: (id)  sender
implementation

Definition at line 574 of file CPControl.j.

- (void) takeIntValueFrom: (id)  sender
implementation

Definition at line 580 of file CPControl.j.

- (void) takeObjectValueFrom: (id)  sender
implementation

Definition at line 586 of file CPControl.j.

- (void) takeStringValueFrom: (id)  sender
implementation

Definition at line 592 of file CPControl.j.

- (id) target
implementation

Returns the receiver's target. The target receives action messages from the receiver.

Definition at line 212 of file CPControl.j.

- (CPColor) textColor
implementation

Returns the text color of the receiver.

Definition at line 753 of file CPControl.j.

- (void) textDidBeginEditing: (CPNotification note
implementation

Definition at line 598 of file CPControl.j.

- (void) textDidChange: (CPNotification note
implementation

Reimplemented in CPTokenField, and CPComboBox.

Definition at line 607 of file CPControl.j.

- (void) textDidEndEditing: (CPNotification note
implementation

Definition at line 616 of file CPControl.j.

- (CPColor) textShadowColor
implementation

Returns the shadow color of the text for the control.

Definition at line 769 of file CPControl.j.

- (CGSize) textShadowOffset
implementation

Returns the text shadow offset of the receiver.

Definition at line 787 of file CPControl.j.

+ (CPDictionary) themeAttributes
implementation
- (void) trackMouse: (CPEvent anEvent
implementation

Reimplemented in CPBrowser.

Definition at line 271 of file CPControl.j.

- (BOOL) tracksMouseOutsideOfFrame
implementation

Returns YES if the receiver tracks the mouse outside the frame, otherwise NO.

Reimplemented in CPSlider.

Definition at line 266 of file CPControl.j.

- (void) unhighlightButtonTimerDidFinish: (id)  sender
implementation

Fired when the button timer finished, usually after the user hits enter.

Definition at line 359 of file CPControl.j.

- (CPTextVerticalAlignment) verticalAlignment
implementation

Returns the vertical text alignment of the receiver.

Definition at line 710 of file CPControl.j.


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