summaryrefslogtreecommitdiffstats
path: root/chrome/browser/cocoa/translate_infobar.h
blob: 29536c80e2261bb70370e2288558fbc5b73012d7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
// 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/infobar_controller.h"

#include "base/scoped_nsobject.h"
#include "base/scoped_ptr.h"
#include "chrome/browser/translate/languages_menu_model.h"
#include "chrome/browser/translate/options_menu_model.h"
#include "chrome/browser/translate/translate_infobars_delegates.h"
#include "chrome/common/notification_registrar.h"
#include "chrome/common/translate_errors.h"

class TranslateInfoBarMenuModel;
class TranslateNotificationObserverBridge;

// Draws and maintains Translate Infobar GUI.
// The translate bar can be in one of 3 states:
// 1. "Before Translate" - source language popup and translate/cancel buttons
//    visible.
// 2. "Translating" - "Translating..." status text visible in address bar.
// 3. "After Translation" - source & target language popups visible.
//
// The following state transitions are supported:
// 1->{2,3}
// 2<->3
// i.e. Once you've transitioned out of "Before Translate" mode you can't switch
// back, however all other state transitions are supported.
//
// The GUI uses popup menus interspersed in a text label.  For localization
// purposes this means we potentially need 3 labels to display the UI (the 3rd
// is only visible in certain locales).
@interface TranslateInfoBarController : InfoBarController {
 @protected
  // Infobar keeps track of the state it is displaying, which should match that
  // in the TranslateInfoBarDelegate.  UI needs to keep track separately because
  // infobar may receive PAGE_TRANSLATED notifications before delegate does, in
  // which case, delegate's state is not updated and hence can't be used to
  // update display.  After the notification is sent out to all observers, both
  // infobar and delegate would end up with the same state.
  TranslateInfoBarDelegate::TranslateState state_;

  // Is a translation currently in progress.
  bool translationPending_;

  scoped_nsobject<NSTextField> label1_;
  scoped_nsobject<NSTextField> label2_;
  scoped_nsobject<NSTextField> label3_;
  scoped_nsobject<NSTextField> translatingLabel_;
  scoped_nsobject<NSPopUpButton> fromLanguagePopUp_;
  scoped_nsobject<NSPopUpButton> toLanguagePopUp_;
  scoped_nsobject<NSPopUpButton> optionsPopUp_;
  scoped_nsobject<NSButton> showOriginalButton_;
  scoped_nsobject<NSButton> tryAgainButton_;

  // In the current locale, are the "from" and "to" language popup menu
  // flipped from what they'd appear in English.
  bool swappedLanguagePlaceholders_;

  // Space between controls in pixels - read from the NIB.
  CGFloat spaceBetweenControls_;
  int numLabelsDisplayed_;

  scoped_ptr<LanguagesMenuModel> original_language_menu_model_;
  scoped_ptr<LanguagesMenuModel> target_language_menu_model_;
  scoped_ptr<OptionsMenuModel> options_menu_model_;
  scoped_ptr<TranslateInfoBarMenuModel> menu_model_;
  scoped_ptr<TranslateNotificationObserverBridge> observer_bridge_;
}

// Called when the "Show Original" button is pressed.
- (IBAction)showOriginal:(id)sender;

@end

@interface TranslateInfoBarController (TestingAPI)

// Main function to update the toolbar graphic state and data model after
// the state has changed.
// Controls are moved around as needed and visibility changed to match the
// current state.
- (void)updateState:(TranslateInfoBarDelegate::TranslateState)newState
 translationPending:(bool)newTranslationPending
              error:(TranslateErrors::Type)error;


// Called when the source or target language selection changes in a menu.
// |newLanguageIdx| is the index of the newly selected item in the appropriate
// menu.
- (void)sourceLanguageModified:(NSInteger)newLanguageIdx;
- (void)targetLanguageModified:(NSInteger)newLanguageIdx;

// Called when an item in one of the toolbar's menus is selected.
- (void)menuItemSelected:(id)item;

// Returns the underlying options menu.
- (NSMenu*)optionsMenu;

// Returns the "try again" button.
- (NSButton*)tryAgainButton;

// The TranslateInfoBarController's internal idea of the current state.
- (TranslateInfoBarDelegate::TranslateState)state;

// Verifies that the layout of the infobar is correct for |state|.
- (bool)verifyLayout:(TranslateInfoBarDelegate::TranslateState)state
  translationPending:(bool)translationPending;

// Teardown and rebuild the options menu.
- (void)rebuildOptionsMenu;

@end