ios/chrome/browser/ui/omnibox/omnibox_text_field_ios.h

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_TEXT_FIELD_IOS_H_
#define IOS_CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_TEXT_FIELD_IOS_H_

#import <UIKit/UIKit.h>

#import "ios/chrome/browser/ui/omnibox/omnibox_keyboard_delegate.h"
#import "ios/chrome/browser/ui/omnibox/omnibox_text_field_delegate.h"

// Enum type specifying the direction of fade animations.
typedef enum {
  OMNIBOX_TEXT_FIELD_FADE_STYLE_IN,
  OMNIBOX_TEXT_FIELD_FADE_STYLE_OUT
} OmniboxTextFieldFadeStyle;

// UITextField subclass to allow for adjusting borders.
@interface OmniboxTextFieldIOS : UITextField <OmniboxKeyboardDelegate>

// Initialize the omnibox with the given frame, text color, and tint color.
- (instancetype)initWithFrame:(CGRect)frame
                    textColor:(UIColor*)textColor
                    tintColor:(UIColor*)tintColor;

// Sets the field's text to `text`.  If `userTextLength` is less than the length
// of `text`, the excess is displayed as inline autocompleted text.  When the
// field is not in editing mode, it will respect the text attributes set on
// `text`.
- (void)setText:(NSAttributedString*)text userTextLength:(size_t)userTextLength;

// Inserts the given `text` into the text field.  The text replaces the current
// selection, if there is one; otherwise the text is inserted at the current
// cursor position.  This method should only be called while editing.
- (void)insertTextWhileEditing:(NSString*)text;

// Returns the text that is displayed in the field, including any inline
// autocomplete text that may be present.
- (NSString*)displayedText;

// Returns self.text without the autocomplete part, if it's available.
- (NSString*)userText;

// Returns just the portion of `-displayedText` that is inline autocompleted.
- (NSString*)autocompleteText;

// Returns YES if this field is currently displaying any inline autocompleted
// text.
- (BOOL)hasAutocompleteText;

// Removes any inline autocompleted text that may be present.  Any text that is
// actually present in the field (not inline autocompleted) remains untouched.
- (void)clearAutocompleteText;

// On iOS 5.0+, returns any marked text in the field.  Marked text is text that
// is part of a pending IME composition.  It is an error to call this function
// on older version of iOS.
- (NSString*)markedText;

// Returns the current selected text range as an NSRange.
- (NSRange)selectedNSRange;

// Returns the most likely text alignment, Left or Right, based on the best
// language match for `self.text`.
- (NSTextAlignment)bestTextAlignment;

// Returns the most likely semantic content attribute -- right to left, left to
// right or unspecified -- based on the first character of `self.text` and the
// device's current locale.
- (UISemanticContentAttribute)bestSemanticContentAttribute;

// Checks if direction of the omnibox text changed, and updates the UITextField.
// alignment if necessary.
- (void)updateTextDirection;

// The color of the displayed text. Does not return the UITextField's textColor
// property.
- (UIColor*)displayedTextColor;

// Fade in/out the text and auxiliary views depending on `style`.
- (void)animateFadeWithStyle:(OmniboxTextFieldFadeStyle)style;
// Called when animations added by `-animateFadeWithStyle:` can be removed.
- (void)cleanUpFadeAnimations;

// Returns an x offset for a given string. If no such string is found, returns
// some default offset.
// Used for focus/defocus animation.
- (CGFloat)offsetForString:(NSString*)string;

// Initial touch on the Omnibox triggers a "pre-edit" state. The current
// URL is shown without any insertion point. First character typed replaces
// the URL. A second touch turns on the insertion point. `preEditStaticLabel`
// is normally hidden. In pre-edit state, `preEditStaticLabel` is unhidden
// and displays the URL that will be edited on the second touch.
- (void)enterPreEditState;
- (void)exitPreEditState;
- (BOOL)isPreEditing;

// The delegate for this textfield.  Overridden to use OmniboxTextFieldDelegate
// instead of UITextFieldDelegate.
@property(nonatomic, weak) id<OmniboxTextFieldDelegate> delegate;
// Object that handles arrow keys behavior in Omnibox dispatching to multiple
// OmniboxKeyboardDelegates.
@property(nonatomic, weak) id<OmniboxKeyboardDelegate> omniboxKeyboardDelegate;

// Text displayed when in pre-edit state.
@property(nonatomic, strong) NSString* preEditText;

@property(nonatomic) BOOL clearingPreEditText;
@property(nonatomic, readonly, strong) UIColor* selectedTextBackgroundColor;
@property(nonatomic, strong) UIColor* placeholderTextColor;
@property(nonatomic, assign) BOOL incognito;

@end

// A category for defining new methods that access private ivars.
@interface OmniboxTextFieldIOS (TestingUtilities)
- (UILabel*)preEditStaticLabel;
@end

#endif  // IOS_CHROME_BROWSER_UI_OMNIBOX_OMNIBOX_TEXT_FIELD_IOS_H_