chrome/browser/ui/cocoa/omnibox/omnibox_popup_matrix.h

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CHROME_BROWSER_UI_COCOA_OMNIBOX_OMNIBOX_POPUP_MATRIX_H_
   6 #define CHROME_BROWSER_UI_COCOA_OMNIBOX_OMNIBOX_POPUP_MATRIX_H_
   7
   8 #import <Cocoa/Cocoa.h>
   9
  10 #import "ui/base/cocoa/tracking_area.h"
  11 #include "ui/base/window_open_disposition.h"
  12
  13 class AutocompleteResult;
  14 @class OmniboxPopupCell;
  15 @class OmniboxPopupMatrix;
  16 class OmniboxPopupViewMac;
  17
  18 @interface OmniboxPopupTableController
  19     : NSViewController<NSTableViewDelegate, NSTableViewDataSource> {
  20  @private
  21   base::scoped_nsobject<NSArray> array_;
  22   NSInteger hoveredIndex_;
  23 };
  24
  25 // Setup the information used by the NSTableView data source.
  26 - (instancetype)initWithMatchResults:(const AutocompleteResult&)result
  27                            tableView:(OmniboxPopupMatrix*)tableView
  28                            popupView:(const OmniboxPopupViewMac&)popupView
  29                          answerImage:(NSImage*)answerImage;
  30
  31 // Set the hovered highlight.
  32 - (void)setHighlightedRow:(NSInteger)rowIndex;
  33
  34 // Which row has the hovered highlight.
  35 - (NSInteger)highlightedRow;
  36
  37 @end
  38
  39 @interface OmniboxPopupTableController (TestingAPI)
  40 - (instancetype)initWithArray:(NSArray*)array;
  41 @end
  42
  43 @class OmniboxPopupMatrix;
  44
  45 class OmniboxPopupMatrixObserver {
  46  public:
  47   // Called when the selection in the matrix changes.
  48   virtual void OnMatrixRowSelected(OmniboxPopupMatrix* matrix, size_t row) = 0;
  49
  50   // Called when the user clicks on a row.
  51   virtual void OnMatrixRowClicked(OmniboxPopupMatrix* matrix, size_t row) = 0;
  52
  53   // Called when the user middle clicks on a row.
  54   virtual void OnMatrixRowMiddleClicked(OmniboxPopupMatrix* matrix,
  55                                         size_t row) = 0;
  56 };
  57
  58 // Sets up a tracking area to implement hover by highlighting the cell the mouse
  59 // is over.
  60 @interface OmniboxPopupMatrix : NSTableView {
  61   base::scoped_nsobject<OmniboxPopupTableController> matrixController_;
  62   OmniboxPopupMatrixObserver* observer_;  // weak
  63   ui::ScopedCrTrackingArea trackingArea_;
  64   NSAttributedString* separator_;
  65
  66   // The width of widest match contents in a set of infinite suggestions.
  67   CGFloat maxMatchContentsWidth_;
  68
  69   CGFloat answerLineHeight_;
  70 }
  71
  72 @property(retain, nonatomic) NSAttributedString* separator;
  73 @property(nonatomic) CGFloat maxMatchContentsWidth;
  74 @property(nonatomic) CGFloat answerLineHeight;
  75
  76 // Create a zero-size matrix.
  77 - (instancetype)initWithObserver:(OmniboxPopupMatrixObserver*)observer;
  78
  79 // Sets the observer.
  80 - (void)setObserver:(OmniboxPopupMatrixObserver*)observer;
  81
  82 // Return the currently highlighted row.  Returns -1 if no row is highlighted.
  83 - (NSInteger)highlightedRow;
  84
  85 // Move the selection to |rowIndex|.
  86 - (void)selectRowIndex:(NSInteger)rowIndex;
  87
  88 // Setup the NSTableView data source.
  89 - (void)setController:(OmniboxPopupTableController*)controller;
  90
  91 @end
  92
  93 #endif  // CHROME_BROWSER_UI_COCOA_OMNIBOX_OMNIBOX_POPUP_MATRIX_H_