API  1.0.0
CPSearchField Class Reference

#import <CPSearchField.h>

+ Inheritance diagram for CPSearchField:

Instance Methods

(CPButton- cancelButton
 
(CGRect) - cancelButtonRectForBounds:
 
(void) - cancelOperation:
 
(CGRect) - contentRectForBounds:
 
(void) - cursorUpdate:
 
(CPMenu- defaultSearchMenuTemplate
 
(void) - encodeWithCoder:
 
(CPView- hitTest:
 
(id) - initWithCoder:
 
(id) - initWithFrame:
 
(BOOL) - isOpaque
 
(int) - maximumRecents
 
(CPMenu- menu
 
(void) - menuDidClose:
 
(void) - menuWillOpen:
 
(void) - mouseDown:
 
(CPString- recentsAutosaveName
 
(CPArray) - recentSearches
 
(void) - resetCancelButton
 
(void) - resetSearchButton
 
(BOOL) - resignFirstResponder
 
(CPButton- searchButton
 
(CGRect) - searchButtonRectForBounds:
 
(CPMenu- searchMenuTemplate
 
(CGRect) - searchTextRectForBounds:
 
(BOOL) - sendAction:to:
 
(BOOL) - sendsSearchStringImmediately
 
(BOOL) - sendsWholeSearchString
 
(void) - setCancelButton:
 
(void) - setMaximumRecents:
 
(void) - setRecentsAutosaveName:
 
(void) - setRecentSearches:
 
(void) - setSearchButton:
 
(void) - setSearchMenuTemplate:
 
(void) - setSendsSearchStringImmediately:
 
(void) - setSendsWholeSearchString:
 
(void) - unbind:
 
(void) - updateTrackingAreas
 
- Instance Methods inherited from CPTextField
(BOOL) - acceptsFirstMouse:
 
(BOOL) - acceptsFirstResponder
 
(BOOL) - becomeFirstResponder
 
(CGRect) - bezelRectForBounds:
 
(CPTextFieldBezelStyle) - bezelStyle
 
(void) - copy:
 
(CPView- createEphemeralSubviewNamed:
 
(void) - cut:
 
(id) - delegate
 
(void) - delete:
 
(void) - deleteBackward:
 
(void) - deleteForward:
 
(void) - doCommandBySelector:
 
(BOOL) - drawsBackground
 
(void) - insertNewline:
 
(void) - insertNewlineIgnoringFieldEditor:
 
(void) - insertTabIgnoringFieldEditor:
 
(BOOL) - isBezeled
 
(BOOL) - isBordered
 
(BOOL) - isEditable
 
(BOOL) - isSecure
 
(BOOL) - isSelectable
 
(void) - keyDown:
 
(void) - keyUp:
 
(void) - layoutSubviews
 
(void) - mouseDragged:
 
(void) - mouseUp:
 
(BOOL) - needsPanelToBecomeKey
 
(id) - objectValue
 
(void) - paste:
 
(CPString- placeholderString
 
(CGRect) - rectForEphemeralSubviewNamed:
 
(void) - rightMouseDown:
 
(void) - selectAll:
 
(CPRange) - selectedRange
 
(void) - selectText:
 
(void) - setBezeled:
 
(void) - setBezelStyle:
 
(void) - setBordered:
 
(void) - setControlSize:
 
(void) - setDelegate:
 
(void) - setDrawsBackground:
 
(void) - setEditable:
 
(void) - setEnabled:
 
(void) - setObjectValue:
 
(void) - setPlaceholderString:
 
(void) - setSecure:
 
(void) - setSelectable:
 
(void) - setSelectedRange:
 
(void) - setTextColor:
 
(void) - setTextFieldBackgroundColor:
 
(void) - setValue:forThemeAttribute:
 
(void) - sizeToFit
 
(void) - takeValueFromKeyPath:ofObjects:
 
(void) - textDidBeginEditing:
 
(void) - textDidBlur:
 
(void) - textDidChange:
 
(void) - textDidEndEditing:
 
(void) - textDidFocus:
 
(CPColor- textFieldBackgroundColor
 
(BOOL) - validateUserInterfaceItem:
 
(void) - viewDidHide
 
(void) - viewDidUnhide
 
- Instance Methods inherited from CPControl
(SEL) - action
 
(CPTextAlignment) - alignment
 
(CPWritingDirection) - baseWritingDirection
 
(BOOL) - continueTracking:at:
 
(CPControlSize) - controlSize
 
(double) - doubleValue
 
(float) - floatValue
 
(CPFont- font
 
(CPFormatter- formatter
 
(void) - highlight:
 
(CPCellImagePosition) - imagePosition
 
(CPUInteger) - imageScaling
 
(int) - integerValue
 
(int) - intValue
 
(BOOL) - isContinuous
 
(BOOL) - isEnabled
 
(BOOL) - isHighlighted
 
(CPLineBreakMode) - lineBreakMode
 
(unsigned) - mouseDownFlags
 
(void) - mouseEntered:
 
(void) - mouseExited:
 
(CPInteger) - nextState
 
(void) - performClick:
 
(int) - sendActionOn:
 
(BOOL) - sendsActionOnEndEditing
 
(void) - setAction:
 
(void) - setAlignment:
 
(void) - setBaseWritingDirection:
 
(void) - setContinuous:
 
(void) - setDoubleValue:
 
(void) - setFloatValue:
 
(void) - setFont:
 
(void) - setFormatter:
 
(void) - setHighlighted:
 
(void) - setImagePosition:
 
(void) - setImageScaling:
 
(void) - setIntegerValue:
 
(void) - setIntValue:
 
(void) - setLineBreakMode:
 
(void) - setSendsActionOnEndEditing:
 
(void) - setState:
 
(void) - setStringValue:
 
(void) - setTarget:
 
(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
 
(CPColor- textShadowColor
 
(CGSize) - textShadowOffset
 
(void) - trackMouse:
 
(BOOL) - tracksMouseOutsideOfFrame
 
(void) - unhighlightButtonTimerDidFinish:
 
(CPTextVerticalAlignment) - verticalAlignment
 
- Instance Methods inherited from CPView
(void) - addSubview:
 
(void) - addSubview:positioned:relativeTo:
 
(void) - addTrackingArea:
 
(CGRect) - adjustScroll:
 
(float) - alphaValue
 
(CAAnimation- animationForKey:
 
(CPDictionary- animations
 
(id) - animator
 
(BOOL) - autoresizesSubviews
 
(unsigned) - autoresizingMask
 
(BOOL) - autoscroll:
 
(CPColor- backgroundColor
 
(CGRect) - bounds
 
(CGPoint) - boundsOrigin
 
(CGSize) - boundsSize
 
(BOOL) - canBecomeKeyView
 
(CGPoint) - center
 
(BOOL) - clipsToBounds
 
(CGPoint) - convertPoint:fromView:
 
(CGPoint) - convertPoint:toView:
 
(CGPoint) - convertPointFromBase:
 
(CGPoint) - convertPointToBase:
 
(CGRect) - convertRect:fromView:
 
(CGRect) - convertRect:toView:
 
(CGRect) - convertRectFromBase:
 
(CGRect) - convertRectToBase:
 
(CGSize) - convertSize:fromView:
 
(CGSize) - convertSize:toView:
 
(CPString- debug_description
 
(void) - didAddSubview:
 
(void) - display
 
(void) - displayIfNeeded
 
(void) - displayIfNeededInRect:
 
(void) - displayRect:
 
(void) - displayRectIgnoringOpacity:inContext:
 
(void) - dragImage:at:offset:event:pasteboard:source:slideBack:
 
(void) - dragView:at:offset:event:pasteboard:source:slideBack:
 
(void) - drawRect:
 
(CPAppearance- effectiveAppearance
 
(CPMenuItem- enclosingMenuItem
 
(CPScrollView- enclosingScrollView
 
(BOOL) - enterFullScreenMode
 
(BOOL) - enterFullScreenMode:withOptions:
 
(CPView- ephemeralSubviewNamed:
 
(void) - exitFullScreenMode
 
(void) - exitFullScreenModeWithOptions:
 
(CGRect) - frame
 
(CGPoint) - frameOrigin
 
(CGRect) - frameRectOfView:inSuperviewSize:
 
(CGSize) - frameSize
 
(CGRect) - frameWithNewSuperviewSize:
 
(BOOL) - hasCustomDrawRect
 
(BOOL) - hasCustomLayoutSubviews
 
(BOOL) - hitTests
 
(id) - init
 
(BOOL) - inLiveResize
 
(BOOL) - isDescendantOf:
 
(BOOL) - isFlipped
 
(BOOL) - isHidden
 
(BOOL) - isHiddenOrHasHiddenAncestor
 
(BOOL) - isInFullScreenMode
 
(CALayer- layer
 
(void) - layout
 
(CPView- layoutEphemeralSubviewNamed:positioned:relativeToEphemeralSubviewNamed:
 
(void) - layoutIfNeeded
 
(void) - lockFocus
 
(CPMenu- menuForEvent:
 
(BOOL) - mouseDownCanMoveWindow
 
(BOOL) - needsDisplay
 
(BOOL) - needsLayout
 
(CPView- nextKeyView
 
(CPView- nextValidKeyView
 
(void) - objectDidChangeTheme
 
(BOOL) - performKeyEquivalent:
 
(BOOL) - postsBoundsChangedNotifications
 
(BOOL) - postsFrameChangedNotifications
 
(CPView- previousKeyView
 
(CPView- previousValidKeyView
 
(void) - reflectScrolledClipView:
 
(CPArray) - registeredDraggedTypes
 
(void) - registerForDraggedTypes:
 
(void) - removeFromSuperview
 
(void) - removeTrackingArea:
 
(void) - replaceSubview:with:
 
(void) - resizeSubviewsWithOldSize:
 
(void) - resizeWithOldSuperviewSize:
 
(CGSize) - scaleSize
 
(void) - scaleUnitSquareToSize:
 
(void) - scrollClipView:toPoint:
 
(void) - scrollPoint:
 
(void) - scrollRect:by:
 
(BOOL) - scrollRectToVisible:
 
(void) - setAlphaValue:
 
(void) - setAnimations:
 
(void) - setAppearance:
 
(void) - setAutoresizesSubviews:
 
(void) - setAutoresizingMask:
 
(void) - setBackgroundColor:
 
(void) - setBounds:
 
(void) - setBoundsOrigin:
 
(void) - setBoundsSize:
 
(void) - setCenter:
 
(void) - setClipsToBounds:
 
(void) - setDOMClassName:
 
(void) - setFrame:
 
(void) - setFrameOrigin:
 
(void) - setFrameSize:
 
(void) - setHidden:
 
(void) - setHitTests:
 
(void) - setLayer:
 
(void) - setNeedsDisplay:
 
(void) - setNeedsDisplayInRect:
 
(void) - setNeedsLayout
 
(void) - setNeedsLayout:
 
(void) - setNextKeyView:
 
(void) - setPostsBoundsChangedNotifications:
 
(void) - setPostsFrameChangedNotifications:
 
(void) - setScaleSize:
 
(void) - setSubviews:
 
(void) - setTag:
 
(void) - setThemeClass:
 
(BOOL) - setThemeState:
 
(void) - setToolTip:
 
(void) - setValue:forThemeAttribute:inState:
 
(void) - setWantsLayer:
 
(CPArray) - subviews
 
(CPView- superview
 
(CPInteger) - tag
 
(void) - unlockFocus
 
(void) - unregisterDraggedTypes
 
(BOOL) - unsetThemeState:
 
(void) - viewDidEndLiveResize
 
(void) - viewDidLayout
 
(void) - viewDidMoveToSuperview
 
(void) - viewDidMoveToWindow
 
(void) - viewWillDraw
 
(void) - viewWillLayout
 
(void) - viewWillMoveToSuperview:
 
(void) - viewWillMoveToWindow:
 
(void) - viewWillStartLiveResize
 
(CPView- viewWithTag:
 
(CGRect) - visibleRect
 
(BOOL) - wantsLayer
 
(void) - willRemoveSubview:
 
(CPWindow- window
 

Class Methods

(CPString+ defaultThemeClass
 
(CPDictionary+ themeAttributes
 
- Class Methods inherited from CPTextField
(CPTextField+ labelWithTitle:
 
(CPTextField+ labelWithTitle:theme:
 
(CPTextField+ roundedTextFieldWithStringValue:placeholder:width:
 
(CPTextField+ roundedTextFieldWithStringValue:placeholder:width:theme:
 
(CPTextField+ textFieldWithStringValue:placeholder:width:
 
(CPTextField+ textFieldWithStringValue:placeholder:width:theme:
 
- Class Methods inherited from CPControl
(void) + initialize
 
- Class Methods inherited from CPView
(Class) + animatorClass
 
(CAAnimation+ defaultAnimationForKey:
 
(CPMenu+ defaultMenu
 
(BOOL) + isHighDPIDrawingEnabled
 
(CPSet) + keyPathsForValuesAffectingBounds
 
(CPSet) + keyPathsForValuesAffectingFrame
 
(void) + setHighDPIDrawingEnabled:
 

Detailed Description

The CPSearchField class defines the programmatic interface for text fields that are optimized for text-based searches. A CPSearchField object directly inherits from the CPTextField class. The search field implemented by these classes presents a standard user interface for searches, including a search button, a cancel button, and a pop-up icon menu for listing recent search strings and custom search categories.

When the user types and then pauses, the text field's action message is sent to its target. You can query the text field's string value for the current text to search for. Do not rely on the sender of the action to be an CPMenu object because the menu may change. If you need to change the menu, modify the search menu template and call the setSearchMenuTemplate: method to update.

Definition at line 2 of file CPSearchField.h.

Method Documentation

◆ cancelButton()

- (CPButton) cancelButton
implementation

Returns the button object used to display the cancel-button image.

Returns
The cancel button.

Definition at line 213 of file CPSearchField.j.

◆ cancelButtonRectForBounds:()

- (CGRect) cancelButtonRectForBounds: (CGRect)  rect
implementation

Modifies the bounding rectangle for the cancel button.

Parameters
rectThe updated bounding rectangle to use for the cancel button. The default value is the value passed into the rect parameter. Subclasses can override this method to return a new bounding rectangle for the cancel button. You might use this method to provide a custom layout for the search field control.

Definition at line 281 of file CPSearchField.j.

◆ cancelOperation:()

- (void) cancelOperation: (id)  sender
implementation

Definition at line 703 of file CPSearchField.j.

◆ contentRectForBounds:()

- (CGRect) contentRectForBounds: (CGRect)  bounds
implementation

Reimplemented from CPTextField.

Definition at line 423 of file CPSearchField.j.

◆ cursorUpdate:()

- (void) cursorUpdate: (CPEvent anEvent
implementation

Reimplemented from CPTextField.

Provided by category CPSearchField(CPTrackingArea).

Definition at line 824 of file CPSearchField.j.

◆ defaultSearchMenuTemplate()

- (CPMenu) defaultSearchMenuTemplate
implementation

Provides the common case items for a recent searches menu.

If there are 1 more recent searches, it displays:

Clear
---------------------
Recent Searches
recent search 1
recent search 2
etc.

If you wish to add items before or after the template, you can. If you put items before, a separator will automatically be placed before the default template item. If you add items after the default template, it is your responsibility to add a separator.

To add a custom item:

item = [[CPMenuItem alloc] initWithTitle:"google" action:(google:) keyEquivalent:""]; [item setTag:700]; [item setTarget:self]; [template addItem:item];

Be sure that your custom items do not use tags in the range 1000-1003 inclusive. If you wish to maintain state in custom menu items that you add, you will need to maintain the item state yourself, then in the action method of the custom items, modify the items in the search menu template and send [searchField setSearchMenuTemplate:template] to update the menu.

Definition at line 564 of file CPSearchField.j.

◆ defaultThemeClass()

+ (CPString) defaultThemeClass
implementation

Reimplemented from CPTextField.

Definition at line 57 of file CPSearchField.j.

◆ encodeWithCoder:()

- (void) encodeWithCoder: (CPCoder aCoder
implementation

Encodes the data of this textfield into the provided coder.

Parameters
aCoderthe coder into which the data will be written

Reimplemented from CPTextField.

Provided by category CPSearchField(CPCoding).

Definition at line 844 of file CPSearchField.j.

◆ hitTest:()

- (CPView) hitTest: (CGPoint)  aPoint
implementation

Tests whether a point is contained within this view, or one of its subviews.

Parameters
aPointthe point to test
Returns
returns the containing view, or nil if the point is not contained

Reimplemented from CPView.

Definition at line 497 of file CPSearchField.j.

◆ initWithCoder:()

- (id) initWithCoder: (CPCoder aCoder
implementation

Initializes the textfield with data from a coder.

Parameters
aCoderthe coder from which to read the textfield data
Returns
the initialized textfield

Reimplemented from CPTextField.

Provided by category CPSearchField(CPCoding).

Definition at line 867 of file CPSearchField.j.

◆ initWithFrame:()

- (id) initWithFrame: (CGRect)  aFrame
implementation

Initializes the receiver for usage with the specified bounding rectangle

Returns
the initialized view

Reimplemented from CPTextField.

Definition at line 84 of file CPSearchField.j.

◆ isOpaque()

- (BOOL) isOpaque
implementation

Returns whether the receiver is completely opaque. By default, returns NO.

Reimplemented from CPView.

Definition at line 439 of file CPSearchField.j.

◆ maximumRecents()

- (int) maximumRecents
implementation

Returns the maximum number of recent search strings to display in the custom search menu.

Returns
The maximum number of search strings that can appear in the menu. This value is between 0 and 254.

Definition at line 355 of file CPSearchField.j.

◆ menu()

- (CPMenu) menu
implementation

Definition at line 434 of file CPSearchField.j.

◆ menuDidClose:()

- (void) menuDidClose: (CPMenu menu
implementation

Definition at line 675 of file CPSearchField.j.

◆ menuWillOpen:()

- (void) menuWillOpen: (CPMenu menu
implementation

Definition at line 670 of file CPSearchField.j.

◆ mouseDown:()

- (void) mouseDown: (CPEvent anEvent
implementation

Reimplemented from CPTextField.

Definition at line 511 of file CPSearchField.j.

◆ recentsAutosaveName()

- (CPString) recentsAutosaveName
implementation

Returns the key under which the prior list of recent search strings has been archived.

Returns
The autosave name, which is used as a key in the standard user defaults to save the recent searches. The default value is nil, which causes searches not to be autosaved.

Definition at line 401 of file CPSearchField.j.

◆ recentSearches()

- (CPArray) recentSearches
implementation

Returns the list of recent search strings for the control.

Returns
An array of CPString objects, each of which contains a search string either displayed in the search menu or from a recent autosave archive. If there have been no recent searches and no prior searches saved under an autosave name, this array may be empty.

Definition at line 378 of file CPSearchField.j.

◆ resetCancelButton()

- (void) resetCancelButton
implementation

Resets the cancel button to its default attributes. This method resets the target, action, regular image, and pressed image. This method gives you a way to customize the cancel button for specific situations and then reset the button defaults without having to undo changes individually.

Definition at line 222 of file CPSearchField.j.

◆ resetSearchButton()

- (void) resetSearchButton
implementation

Resets the search button to its default attributes. This method resets the target, action, regular image, and pressed image. By default, when users click the search button or press the Return key, the action defined for the receiver is sent to its designated target. This method gives you a way to customize the search button for specific situations and then reset the button defaults without having to undo changes individually.

Definition at line 177 of file CPSearchField.j.

◆ resignFirstResponder()

- (BOOL) resignFirstResponder
implementation

Reimplemented from CPTextField.

Definition at line 506 of file CPSearchField.j.

◆ searchButton()

- (CPButton) searchButton
implementation

Returns the button used to display the search-button image.

Returns
The search button.

Definition at line 168 of file CPSearchField.j.

◆ searchButtonRectForBounds:()

- (CGRect) searchButtonRectForBounds: (CGRect)  rect
implementation

Modifies the bounding rectangle for the search button.

Parameters
rectThe current bounding rectangle for the search button. Subclasses can override this method to return a new bounding rectangle for the search button. You might use this method to provide a custom layout for the search field control.

Definition at line 268 of file CPSearchField.j.

◆ searchMenuTemplate()

- (CPMenu) searchMenuTemplate
implementation

Returns the menu template object used to dynamically construct the search pop-up icon menu.

Returns
The current menu template.

Definition at line 294 of file CPSearchField.j.

◆ searchTextRectForBounds:()

- (CGRect) searchTextRectForBounds: (CGRect)  rect
implementation

Modifies the bounding rectangle for the search-text field.

Parameters
rectThe current bounding rectangle for the search text field.
Returns
The updated bounding rectangle to use for the search text field. The default value is the value passed into the rect parameter. Subclasses can override this method to return a new bounding rectangle for the text-field object. You might use this method to provide a custom layout for the search field control.

Definition at line 241 of file CPSearchField.j.

◆ sendAction:to:()

- (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 from CPControl.

Definition at line 476 of file CPSearchField.j.

◆ sendsSearchStringImmediately()

- (BOOL) sendsSearchStringImmediately
implementation

Returns a Boolean value indicating whether the receiver sends its action immediately upon being notified of changes to the search field text or after a brief pause.

Returns
YES if the text field sends its action immediately upon notification of any changes to the search field; otherwise, NO.

Definition at line 336 of file CPSearchField.j.

◆ sendsWholeSearchString()

- (BOOL) sendsWholeSearchString
implementation

Returns a Boolean value indicating whether the receiver sends the search action message when the user clicks the search button (or presses return) or after each keystroke.

Returns
YES if the action message is sent all at once when the user clicks the search button or presses return; otherwise, NO if the search string is sent after each keystroke. The default value is NO.

Definition at line 318 of file CPSearchField.j.

◆ setCancelButton:()

- (void) setCancelButton: (CPButton button
implementation

Sets the button object used to display the cancel-button image.

Parameters
buttonThe cancel button.

Definition at line 192 of file CPSearchField.j.

◆ setMaximumRecents:()

- (void) setMaximumRecents: (int)  max
implementation

Sets the maximum number of search strings that can appear in the search menu.

Parameters
maxRecentsThe maximum number of search strings that can appear in the menu. This value can be between 0 and 254. Specifying a value less than 0 sets the value to the default, which is 10. Specifying a value greater than 254 sets the maximum to 254.

Definition at line 364 of file CPSearchField.j.

◆ setRecentsAutosaveName:()

- (void) setRecentsAutosaveName: (CPString name
implementation

Sets the autosave name under which the receiver automatically archives the list of recent search strings.

Parameters
nameThe autosave name, which is used as a key in the standard user defaults to save the recent searches. If you specify nil or an empty string for this parameter, no autosave name is set and searches are not autosaved.

Definition at line 410 of file CPSearchField.j.

◆ setRecentSearches:()

- (void) setRecentSearches: (CPArray)  searches
implementation

Sets the list of recent search strings to list in the pop-up icon menu of the receiver.

Parameters
searchesAn array of CPString objects containing the search strings. You might use this method to set the recent list of searches from an archived copy.

Definition at line 388 of file CPSearchField.j.

◆ setSearchButton:()

- (void) setSearchButton: (CPButton button
implementation

Sets the button used to display the search-button image

Parameters
buttonThe search button.

Definition at line 151 of file CPSearchField.j.

◆ setSearchMenuTemplate:()

- (void) setSearchMenuTemplate: (CPMenu aMenu
implementation

Sets the menu template object used to dynamically construct the receiver's pop-up icon menu.

Parameters
menuThe menu template to use. The receiver looks for the tag constants described in ŇMenu tagsÓ to determine how to populate the menu with items related to recent searches. See ŇConfiguring a Search MenuÓ for a sample of how you might set up the search menu template.

Definition at line 304 of file CPSearchField.j.

◆ setSendsSearchStringImmediately:()

- (void) setSendsSearchStringImmediately: (BOOL)  flag
implementation

Sets whether the text field sends its action message to the target immediately upon notification of any changes to the search field text or after a brief pause.

Parameters
flagYES to send the text field's action immediately upon notification of any changes to the search field; otherwise, NO if you want the text field to pause briefly before sending its action message. Pausing gives the user the opportunity to type more text into the search field before initiating the search.

Definition at line 345 of file CPSearchField.j.

◆ setSendsWholeSearchString:()

- (void) setSendsWholeSearchString: (BOOL)  flag
implementation

Sets whether the receiver sends the search action message when the user clicks the search button (or presses return) or after each keystroke.

Parameters
flagYES to send the action message all at once when the user clicks the search button or presses return; otherwise, NO to send the search string after each keystroke.

Definition at line 327 of file CPSearchField.j.

◆ themeAttributes()

+ (CPDictionary) themeAttributes
implementation

Reimplemented from CPTextField.

Definition at line 62 of file CPSearchField.j.

◆ unbind:()

- (void) unbind: (CPString aBinding
implementation

Definition at line 767 of file CPSearchField.j.

◆ updateTrackingAreas()

- (void) updateTrackingAreas
implementation

Invoked automatically when the view’s geometry changes such that its tracking areas need to be recalculated.

You should override this method to remove out of date tracking areas, add recomputed tracking areas and then call super;

Cocoa calls this on every view, whereas they have tracking area(s) or not. Cappuccino behaves differently :

  • updateTrackingAreas is called during initWithFrame
  • updateTrackingAreas is also called when placing a view in the view hierarchy (that is in a window)
  • if you have only CPTrackingInVisibleRect tracking areas attached to a view, it will not be called again (until you move the view in the hierarchy)
  • if you have at least one non-CPTrackingInVisibleRect tracking area attached, it will be called every time the view geometry could be modified You don't have to touch to CPTrackingInVisibleRect tracking areas, they will be automatically updated

Please note that it is the owner of a tracking area who is called for updateTrackingAreas. But, if a view without any tracking area is inserted in the view hierarchy (that is, in a window), the view is called for updateTrackingAreas. This enables you to use updateTrackingArea to initially attach your tracking areas to the view.

Reimplemented from CPTextField.

Provided by category CPSearchField(CPTrackingArea).

Definition at line 787 of file CPSearchField.j.


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