// Copyright (c) 2009 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#import <Cocoa/Cocoa.h>

#include "base/scoped_nsobject.h"

// AutocompleteTextFieldCell customizes the look of the Omnibox text
// field.  The border and focus ring are modified, as is the font
// baseline.

// The cell also provides support for certain decorations to be
// applied to the field.  These are the search hint ("Type to search"
// on the right-hand side), the keyword hint ("Press [Tab] to search
// Engine" on the right-hand side), and keyword mode ("Search Engine:"
// in a button-like token on the left-hand side).
//
// The cell arranges the field-editor's placement via the standard
// -editWithFrame:* and -selectWithFrame:* methods.  When the visible
// decoration changes, the cell's look may change, and if the cell is
// currently being edited the field editor will require adjustment.
// The cell signals this requirement by returning YES for
// -fieldEditorNeedsReset, which is used by AutocompleteTextField's
// -resetFieldEditorFrameIfNeeded in testing if re-layout is needed.

@interface AutocompleteTextFieldCell : NSTextFieldCell {
 @private
  // Set if there is a string to display in a rounded rect on the
  // left-hand side of the field.  Exclusive WRT |hintString_|.
  scoped_nsobject<NSAttributedString> keywordString_;

  // Set if there is a string to display as a hint on the right-hand
  // side of the field.  Exclusive WRT |keywordString_|;
  scoped_nsobject<NSAttributedString> hintString_;

  // YES if the info cell has been changed in a way which would result
  // in the cell needing to be laid out again.
  BOOL fieldEditorNeedsReset_;

  // Icon that represents the state of the SSL connection
  scoped_nsobject<NSImage> hintIcon_;

  // Optional text that appears to the right of the hint icon which
  // appears only alongside the icon (i.e., it's possible to display a
  // hintIcon without an hintIconLabel, but not vice-versa).
  scoped_nsobject<NSAttributedString> hintIconLabel_;
}

@property BOOL fieldEditorNeedsReset;

// The following setup |keywordString_| or |hintString_| based on the
// input, and set |fieldEditorNeedsReset_| if the layout of the field
// changed.

// Chooses |partialString| if |width| won't fit |fullString|.  Strings
// must be non-nil.
- (void)setKeywordString:(NSString*)fullString
           partialString:(NSString*)partialString
          availableWidth:(CGFloat)width;

// Chooses |anImage| only if all pieces won't fit w/in |width|.
// Inputs must be non-nil.
- (void)setKeywordHintPrefix:(NSString*)prefixString
                       image:(NSImage*)anImage
                      suffix:(NSString*)suffixString
              availableWidth:(CGFloat)width;

// Suppresses hint entirely if |aString| won't fit w/in |width|.
// String must be non-nil.
- (void)setSearchHintString:(NSString*)aString
             availableWidth:(CGFloat)width;
- (void)clearKeywordAndHint;

// Sets the hint icon and optional icon label. If |icon| is nil, the current
// icon is cleared. If |label| is provided, |color| must be provided as well.
- (void)setHintIcon:(NSImage*)icon label:(NSString*)label color:(NSColor*)color;

// Return the portion of the cell to show the text cursor over.
- (NSRect)textCursorFrameForFrame:(NSRect)cellFrame;

// Return the portion of the cell to use for text display.  This
// corresponds to the frame with our added decorations sliced off.
- (NSRect)textFrameForFrame:(NSRect)cellFrame;

// Return the portion of the cell to use for displaing the |hintIcon_|.
- (NSRect)hintImageFrameForFrame:(NSRect)cellFrame;

@end

// Internal methods here exposed for unit testing.
@interface AutocompleteTextFieldCell (UnitTesting)

@property(readonly) NSAttributedString* keywordString;
@property(readonly) NSAttributedString* hintString;
@property(readonly) NSImage* hintIcon;
@property(readonly) NSAttributedString* hintIconLabel;

@end