File: tab_group_change_notifier.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (99 lines) | stat: -rw-r--r-- 4,670 bytes parent folder | download | duplicates (5)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_COLLABORATION_INTERNAL_MESSAGING_TAB_GROUP_CHANGE_NOTIFIER_H_
#define COMPONENTS_COLLABORATION_INTERNAL_MESSAGING_TAB_GROUP_CHANGE_NOTIFIER_H_

#include "base/observer_list_types.h"
#include "components/saved_tab_groups/public/saved_tab_group.h"
#include "components/saved_tab_groups/public/saved_tab_group_tab.h"
#include "components/saved_tab_groups/public/tab_group_sync_service.h"
#include "components/saved_tab_groups/public/types.h"

namespace collaboration::messaging {

// The TabGroupChangeNotifier is a class that listens to changes from
// TabGroupSyncService and passes them on to its own observers as delta updates
// of the tab group and tabs.
class TabGroupChangeNotifier
    : public tab_groups::TabGroupSyncService::Observer {
 public:
  // An delta observer that is invoked asynchronously based on updates from the
  // TabGroupSyncService.
  class Observer : public base::CheckedObserver {
   public:
    // Invoked when the service has completed initialization. It is expected
    // that this class is controlled by whoever is acting as the observer, and
    // as such, it is expected that the class has already added its own
    // observer before calling Initialize().
    virtual void OnTabGroupChangeNotifierInitialized() = 0;

    // Invoked when sync is disabled which includes sign out or disabling sync
    // for tabs. On receiving this event, the messaging service is expected to
    // clear the database, in-memory model, and hide any outstanding messages.
    virtual void OnSyncDisabled() = 0;

    // A new tab group was added.
    virtual void OnTabGroupAdded(const tab_groups::SavedTabGroup& added_group,
                                 tab_groups::TriggerSource source) = 0;
    // Tab group was removed, and the old group is provided.
    virtual void OnTabGroupRemoved(tab_groups::SavedTabGroup removed_group,
                                   tab_groups::TriggerSource source) = 0;
    // Called whenever there is a relevant update to tab group name.
    // Note: This is not invoked on tab changes within a tab group.
    virtual void OnTabGroupNameUpdated(
        const tab_groups::SavedTabGroup& updated_group,
        tab_groups::TriggerSource source) = 0;
    // Called whenever there is a relevant update to tab group color.
    // Note: This is not invoked on tab changes within a tab group.
    virtual void OnTabGroupColorUpdated(
        const tab_groups::SavedTabGroup& updated_group,
        tab_groups::TriggerSource source) = 0;

    // A saved tab group was opened, e.g. from tab group revisit surface.
    virtual void OnTabGroupOpened(
        const tab_groups::SavedTabGroup& tab_group) = 0;

    // A saved tab group was closed.
    virtual void OnTabGroupClosed(
        const tab_groups::SavedTabGroup& tab_group) = 0;

    // A new tab was added to the given tab group.
    virtual void OnTabAdded(const tab_groups::SavedTabGroupTab& added_tab,
                            tab_groups::TriggerSource source) = 0;
    // A tab was removed from the given tab group. The last known information
    // about the tab is provided.
    virtual void OnTabRemoved(tab_groups::SavedTabGroupTab removed_tab,
                              tab_groups::TriggerSource source,
                              bool is_selected) = 0;
    // A tab has been updated.
    virtual void OnTabUpdated(const tab_groups::SavedTabGroupTab& before,
                              const tab_groups::SavedTabGroupTab& after,
                              tab_groups::TriggerSource source,
                              bool is_selected) = 0;
    // A tab was selected or deselected.
    virtual void OnTabSelectionChanged(const tab_groups::LocalTabID& tab_id,
                                       bool is_selected) = 0;

    // A tab is "seen" by a local device or other device. On desktop
    // platforms this is called when the tab enters the active state.
    virtual void OnTabLastSeenTimeChanged(const base::Uuid& tab_id,
                                          tab_groups::TriggerSource source) = 0;
  };

  ~TabGroupChangeNotifier() override;

  virtual void AddObserver(Observer* observer) = 0;
  virtual void RemoveObserver(Observer* observer) = 0;

  // Kicks off the initialization of this component.
  virtual void Initialize() = 0;

  // Whether this instance has finished initialization.
  virtual bool IsInitialized() = 0;
};

}  // namespace collaboration::messaging

#endif  // COMPONENTS_COLLABORATION_INTERNAL_MESSAGING_TAB_GROUP_CHANGE_NOTIFIER_H_