[Mac] First part of Omnibox decoration refactor. Enable ev bubble.

chrome/browser/cocoa/location_bar/autocomplete_text_field_cell.h

 // Copyright (c) 2010 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>
 
 #import "chrome/browser/cocoa/styled_text_field_cell.h"
 
 #include "base/scoped_nsobject.h"
 #include "chrome/browser/cocoa/location_bar/location_bar_view_mac.h"
 
 class ExtensionAction;
+class LocationBarDecoration;
 
 // Holds a |LocationBarImageView| and its current rect. Do not keep references
 // to this object, only use it directly after calling |-layedOutIcons:|.
 // TODO(shess): This class is basically a helper for laying out the
 // icons.  Try to refactor it away.  If that is not reasonable, at
 // least split the image and label cases into subclasses once the
 // Omnibox stuff is settled.
 @interface AutocompleteTextFieldIcon : NSObject {
   // YES to draw the label part of |view_|, otherwise draw the image
   // part.
@@ skipping 22 matching lines @@
 
 @end
 
 // AutocompleteTextFieldCell extends StyledTextFieldCell to provide 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).
 @interface AutocompleteTextFieldCell : StyledTextFieldCell {
  @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_;
+  // Decorations which live to the left of the text.  Owned by
+  // |LocationBarViewMac|.
+  std::vector<LocationBarDecoration*> leftDecorations_;
 
   // 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_;
 
-  // The location icon sits at the left-hand side of the field.
-  // |keywordString_| overrides.
-  LocationBarViewMac::LocationIconView* locationIconView_;
-
   // The star icon sits at the right-hand side of the field when an
   // URL is being shown.
   LocationBarViewMac::LocationBarImageView* starIconView_;
 
-  // The security label floats to the left of page actions at the
-  // right-hand side.
-  LocationBarViewMac::LocationBarImageView* securityLabelView_;
-
   // List of views showing visible Page Actions. Owned by the location bar.
   // Display is exclusive WRT the |hintString_| and |keywordString_|.
   // This may be NULL during testing.
   LocationBarViewMac::PageActionViewList* page_action_views_;
 
   // List of content blocked icons. This may be NULL during testing.
   LocationBarViewMac::ContentSettingViews* content_setting_views_;
 }
 
-// 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;
+- (void)clearHint;
 
-- (void)setLocationIconView:(LocationBarViewMac::LocationIconView*)view;
+// Clear |leftDecorations_|.
+- (void)clearDecorations;
+
+// Add a new left-side decoration to the right of the existing
+// left-side decorations.
+- (void)addLeftDecoration:(LocationBarDecoration*)decoration;
+
+// The width available after accounting for decorations.
+- (CGFloat)availableWidthInFrame:(const NSRect)frame;
+
 - (void)setStarIconView:(LocationBarViewMac::LocationBarImageView*)view;
-- (void)setSecurityLabelView:(LocationBarViewMac::LocationBarImageView*)view;
 - (void)setPageActionViewList:(LocationBarViewMac::PageActionViewList*)list;
 - (void)setContentSettingViewsList:
     (LocationBarViewMac::ContentSettingViews*)views;
 
-// Returns the portion of the cell to use for displaying the location
-// icon.
-- (NSRect)locationIconFrameForFrame:(NSRect)cellFrame;
-
 // Returns an array of the visible AutocompleteTextFieldIcon objects. Returns
 // only visible icons.
 - (NSArray*)layedOutIcons:(NSRect)cellFrame;
 
 // Return the rectangle the star is being shown in, for purposes of
 // positioning the bookmark bubble.
 - (NSRect)starIconFrameForFrame:(NSRect)cellFrame;
 
+// Return the frame for |aDecoration| if the cell is in |cellFrame|.
+// Returns |NSZeroRect| for decorations which are not currently
+// visible.
+- (NSRect)frameForDecoration:(const LocationBarDecoration*)aDecoration
+                     inFrame:(NSRect)cellFrame;
+
 // Returns the portion of the cell to use for displaying the Page
 // Action icon at the given index. May be NSZeroRect if the index's
 // action is not visible.  This does a linear walk over all page
 // actions, so do not call this in a loop to get the position of all
 // page actions. Use |-layedOutIcons:| instead in that case.
 - (NSRect)pageActionFrameForIndex:(size_t)index inFrame:(NSRect)cellFrame;
 
 // Similar to |pageActionFrameForIndex:inFrame| but accepts an
 // ExtensionAction for when the index is not known.
 - (NSRect)pageActionFrameForExtensionAction:(ExtensionAction*)action
@@ skipping 11 matching lines @@
 - (NSMenu*)actionMenuForEvent:(NSEvent*)theEvent
                        inRect:(NSRect)cellFrame
                        ofView:(AutocompleteTextField*)controlView;
 
 // Called by |AutocompleteTextField| to let page actions intercept
 // clicks.  Returns |YES| if the click has been intercepted.
 - (BOOL)mouseDown:(NSEvent*)theEvent
            inRect:(NSRect)cellFrame
            ofView:(AutocompleteTextField*)controlView;
 
-// If the location icon is draggable, return its drag pasteboard.
-- (NSPasteboard*)locationDragPasteboard;
-
 @end
 
 // Internal methods here exposed for unit testing.
 @interface AutocompleteTextFieldCell (UnitTesting)
 
-@property(nonatomic, readonly) NSAttributedString* keywordString;
 @property(nonatomic, readonly) NSAttributedString* hintString;
 @property(nonatomic, readonly) NSAttributedString* hintIconLabel;
 
 // Returns the total number of installed Page Actions, visible or not.
 - (size_t)pageActionCount;
 
 @end