summaryrefslogtreecommitdiffstats
path: root/chrome/test/accessibility/browser_impl.h
blob: 51fda4387e859816175622ab5548e9a313cb3dab (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef CHROME_TEST_ACCISSIBILITY_BROWSER_IMPL_H__
#define CHROME_TEST_ACCISSIBILITY_BROWSER_IMPL_H__

#include <vector>

#include "tab_impl.h"

/////////////////////////////////////////////////////////////////////
// CBrowserImpl
// It is a wrapper to Browser specific functionalities.
// Note:
// In most of the tasks, keyboard messages are used for now.
// DoDefaultAction() will be called on accessibility objects,
// once implementation is available in chrome accessibility server.
// And keyboard messages will be tested using ApplyAccelerator().
/////////////////////////////////////////////////////////////////////

class CBrowserImpl {
 public:
  CBrowserImpl() {
    active_tab_index_ = 0;
  }

  // Starts Chrome. Sets active tab index.
  bool Launch(void);

  // Closes Chrome.
  bool Quit(void);

  // Activates the specified tab.
  bool ActivateTab(const INT64 index);

  // Returns URL of the active tab.
  bool GetActiveTabURL(BSTR* url);

  // Gets active tab's title.
  bool GetActiveTabTitle(BSTR* title);

  // Gets active tab index.
  bool GetActiveTabIndex(INT64* index);

  // Returns active tab object.
  bool GetActiveTab(CTabImpl** tab);

  // Returns no. of tabs in tabstrip.
  bool GetTabCount(INT64* count);

  bool GetBrowserProcessCount(INT64* count);

  // Reads browser title, which is also a active tab's title
  bool GetBrowserTitle(BSTR* title);

  // Adds new tab. Maintain current active tab index.
  // Returns created tab, if requested.
  bool AddTab(CTabImpl** tab);

  // Returns tab object of specified index.
  bool GetTab(const INT64 index, CTabImpl** tab);

  // Activate tab of specified index. Maintain current active tab index.
  // Returns created tab, if requested.
  bool GoToTab(const INT64 index, CTabImpl** tab);

  // Move to next tab. Maintain current active tab index.
  // Returns created tab, if requested.
  bool GoToNextTab(CTabImpl** tab);

  // Move to previous tab. Maintain current active tab index.
  // Returns created tab, if requested.
  bool GoToPrevTab(CTabImpl** tab);

  // Wait for chrome window to be visible. It checks for accessibility object
  // for tabstrip after every 'interval' for the specified 'timeout'.
  bool WaitForChromeToBeVisible(const INT64 interval, const INT64 timeout,
                                bool* visible);
  bool WaitForTabCountToChange(const INT64 interval, const INT64 timeout,
                               bool* changed);
  bool WaitForTabToBecomeActive(const INT64 index, const INT64 interval,
                                const INT64 timeout, bool* activated);

  // Sends keyboard message. Sends accelerators.
  bool ApplyAccelerator(VARIANT keys);

  // Sets active tab index.
  void SetActiveTabIndex(INT64 index);

  // Removed tab from tab collection vector.
  void CloseTabFromCollection(INT64 index);

  // Updates tab collection vector
  void UpdateTabCollection(void);

  // Removes tab from tab collection vector.
  void EraseTabCollection(void);

 private:
  // Index of active tab.
  INT64 active_tab_index_;

  // Collection of tab data.
  std::vector<ChromeTab*> tab_collection_;
};


#endif  // CHROME_TEST_ACCISSIBILITY_BROWSER_IMPL_H__