|
@@ -0,0 +1,56 @@
|
|
1
|
+/*
|
|
2
|
+ * Copyright (c) 2006-2015 DMDirc Developers
|
|
3
|
+ *
|
|
4
|
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
5
|
+ * of this software and associated documentation files (the "Software"), to deal
|
|
6
|
+ * in the Software without restriction, including without limitation the rights
|
|
7
|
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
+ * copies of the Software, and to permit persons to whom the Software is
|
|
9
|
+ * furnished to do so, subject to the following conditions:
|
|
10
|
+ *
|
|
11
|
+ * The above copyright notice and this permission notice shall be included in
|
|
12
|
+ * all copies or substantial portions of the Software.
|
|
13
|
+ *
|
|
14
|
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
15
|
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
16
|
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
17
|
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
18
|
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
19
|
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
20
|
+ * SOFTWARE.
|
|
21
|
+ */
|
|
22
|
+
|
|
23
|
+package com.dmdirc.ui.messages;
|
|
24
|
+
|
|
25
|
+import com.dmdirc.util.colours.Colour;
|
|
26
|
+
|
|
27
|
+import java.util.Optional;
|
|
28
|
+
|
|
29
|
+/**
|
|
30
|
+ * Keeps track of the number of unread messages in a window, and the most important notification colour for those
|
|
31
|
+ * messages.
|
|
32
|
+ */
|
|
33
|
+public interface UnreadStatusManager {
|
|
34
|
+
|
|
35
|
+ /**
|
|
36
|
+ * Gets the total number of unread lines in the window.
|
|
37
|
+ *
|
|
38
|
+ * @return The number of unread lines
|
|
39
|
+ */
|
|
40
|
+ int getUnreadLines();
|
|
41
|
+
|
|
42
|
+ /**
|
|
43
|
+ * Gets the most significant notification colour for the window, if any. More important events will override the
|
|
44
|
+ * colour of less important events (for example, the colour for a highlight event may replace the colour for
|
|
45
|
+ * an unread message event).
|
|
46
|
+ *
|
|
47
|
+ * @return The notification colour for the window. If empty, there is no active notification.
|
|
48
|
+ */
|
|
49
|
+ Optional<Colour> getNotificationColour();
|
|
50
|
+
|
|
51
|
+ /**
|
|
52
|
+ * Clears the unread status of the window, marking everything as read.
|
|
53
|
+ */
|
|
54
|
+ void clearStatus();
|
|
55
|
+
|
|
56
|
+}
|