Class: UISearchBar

Inherits:

UIView

• Object
• NSObject
• UIResponder
• UIView
• UISearchBar

show all

Overview

Instance Attribute Summary (collapse)

• - autocapitalizationType

  The auto-capitalization style for the text object.

• - autocorrectionType

  The auto-correction style for the text object.

• - backgroundImage

  The background image for the search bar.

• - barStyle

  The style that specifies the receiver’s appearance.

• - delegate

  The search bar’s delegate object.

• - inputAccessoryView

  A custom input accessory view for the keyboard of the search bar.

• - keyboardType

  The keyboard style associated with the text object.

• - placeholder

  The string that is displayed when there is no other text in the text field.

• - prompt

  A single line of text displayed at the top of the search bar.

• - scopeBarBackgroundImage

  The background image for the scope bar.

• - scopeButtonTitles

  An array of strings indicating the titles of the scope buttons.

• - searchFieldBackgroundPositionAdjustment

  The offset of the search text field background in the search bar.

• - searchResultsButtonSelected

  A Boolean value indicating whether the search results button is selected.

• - searchTextPositionAdjustment

  The offset of the text within the search text field background.

• - selectedScopeButtonIndex

  The index of the selected scope button.

• - showsBookmarkButton

  A Boolean value indicating whether the bookmark button is displayed.

• - showsCancelButton

  A Boolean value indicating whether the cancel button is displayed.

• - showsScopeBar

  Specifies whether the scope bar is displayed.

• - showsSearchResultsButton

  A Boolean value indicating whether the search results button is displayed.

• - spellCheckingType

  The spell-checking type.

• - text

  The current or starting search text.

• - tintColor

  The color used to tint the bar.

• - translucent

  Specifies whether the receiver is translucent.

Attributes inherited from UIView

#alpha, #autoresizesSubviews, #autoresizingMask, #backgroundColor, #bounds, #center, #clearsContextBeforeDrawing, #clipsToBounds, #contentMode, #contentScaleFactor, #exclusiveTouch, #frame, #gestureRecognizers, #hidden, #layer, #multipleTouchEnabled, #opaque, #restorationIdentifier, #subviews, #superview, #tag, #transform, #userInteractionEnabled, #window

Attributes inherited from UIResponder

#inputView, #undoManager

Instance Method Summary (collapse)

• - imageForSearchBarIcon:state:

  Returns the image for a given search bar icon type and control state.

• - positionAdjustmentForSearchBarIcon:

  Returns the position adjustment for a given icon.

• - scopeBarButtonBackgroundImageForState:

  Returns the background image for the scope bar button in a given state.

• - scopeBarButtonDividerImageForLeftSegmentState:rightSegmentState:

  Returns the divider image to use for a given combination of left and right segment states.

• - scopeBarButtonTitleTextAttributesForState:

  Returns the text attributes for the search bar’s button’s title string for a given state.

• - searchFieldBackgroundImageForState:

  Returns the search text field image for a given state.

• - setImage:forSearchBarIcon:state:

  Sets the image for a given search bar icon type and control state.

• - setPositionAdjustment:forSearchBarIcon:

  Returns the position adjustment for a given icon.

• - setScopeBarButtonBackgroundImage:forState:

  Sets the background image for the scope bar button in a given state.

• - setScopeBarButtonDividerImage:forLeftSegmentState:rightSegmentState:

  Sets the divider image to use for a given combination of left and right segment states.

• - setScopeBarButtonTitleTextAttributes:forState:

  Sets the text attributes for the search bar’ button’s title string for a given state.

• - setSearchFieldBackgroundImage:forState:

  Sets the search text field image for a given state.

• - setShowsCancelButton:animated:

  Sets the display state of the cancel button optionally with animation.

Methods inherited from UIView

#addConstraint:, #addConstraints:, #addGestureRecognizer:, #addSubview:, #alignmentRectForFrame:, #alignmentRectInsets, animateWithDuration:animations:, animateWithDuration:animations:completion:, animateWithDuration:delay:options:animations:completion:, areAnimationsEnabled, beginAnimations:context:, #bringSubviewToFront:, commitAnimations, #constraints, #constraintsAffectingLayoutForAxis:, #contentCompressionResistancePriorityForAxis:, #contentHuggingPriorityForAxis:, #convertPoint:fromView:, #convertPoint:toView:, #convertRect:fromView:, #convertRect:toView:, #decodeRestorableStateWithCoder:, #didAddSubview:, #didMoveToSuperview, #didMoveToWindow, #drawRect:, #drawRect:forViewPrintFormatter:, #encodeRestorableStateWithCoder:, #endEditing:, #exchangeSubviewAtIndex:withSubviewAtIndex:, #exerciseAmbiguityInLayout, #frameForAlignmentRect:, #gestureRecognizerShouldBegin:, #hasAmbiguousLayout, #hitTest:withEvent:, #initWithFrame:, #insertSubview:aboveSubview:, #insertSubview:atIndex:, #insertSubview:belowSubview:, #intrinsicContentSize, #invalidateIntrinsicContentSize, #isDescendantOfView:, layerClass, #layoutIfNeeded, #layoutSubviews, #needsUpdateConstraints, #pointInside:withEvent:, #removeConstraint:, #removeConstraints:, #removeFromSuperview, #removeGestureRecognizer:, requiresConstraintBasedLayout, #sendSubviewToBack:, setAnimationBeginsFromCurrentState:, setAnimationCurve:, setAnimationDelay:, setAnimationDelegate:, setAnimationDidStopSelector:, setAnimationDuration:, setAnimationRepeatAutoreverses:, setAnimationRepeatCount:, setAnimationStartDate:, setAnimationTransition:forView:cache:, setAnimationWillStartSelector:, setAnimationsEnabled:, #setContentCompressionResistancePriority:forAxis:, #setContentHuggingPriority:forAxis:, #setNeedsDisplay, #setNeedsDisplayInRect:, #setNeedsLayout, #setNeedsUpdateConstraints, #setTranslatesAutoresizingMaskIntoConstraints:, #sizeThatFits:, #sizeToFit, #systemLayoutSizeFittingSize:, transitionFromView:toView:duration:options:completion:, transitionWithView:duration:options:animations:completion:, #translatesAutoresizingMaskIntoConstraints, #updateConstraints, #updateConstraintsIfNeeded, #viewForBaselineLayout, #viewPrintFormatter, #viewWithTag:, #willMoveToSuperview:, #willMoveToWindow:, #willRemoveSubview:

Methods inherited from UIResponder

#becomeFirstResponder, #canBecomeFirstResponder, #canPerformAction:withSender:, #canResignFirstResponder, #isFirstResponder, #motionBegan:withEvent:, #motionCancelled:withEvent:, #motionEnded:withEvent:, #nextResponder, #reloadInputViews, #remoteControlReceivedWithEvent:, #resignFirstResponder, #touchesBegan:withEvent:, #touchesCancelled:withEvent:, #touchesEnded:withEvent:, #touchesMoved:withEvent:

Methods inherited from NSObject

#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version