gomuks/interface/ui.go

81 lines
1.9 KiB
Go
Raw Normal View History

2018-03-18 20:24:03 +01:00
// gomuks - A terminal Matrix client written in Go.
2019-01-17 13:13:25 +01:00
// Copyright (C) 2019 Tulir Asokan
2018-03-18 20:24:03 +01:00
//
// This program is free software: you can redistribute it and/or modify
2019-01-17 13:13:25 +01:00
// it under the terms of the GNU Affero General Public License as published by
2018-03-18 20:24:03 +01:00
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2019-01-17 13:13:25 +01:00
// GNU Affero General Public License for more details.
2018-03-18 20:24:03 +01:00
//
2019-01-17 13:13:25 +01:00
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
2018-03-18 20:24:03 +01:00
package ifc
import (
"time"
"maunium.net/go/gomuks/matrix/pushrules"
"maunium.net/go/gomuks/matrix/rooms"
"maunium.net/go/mautrix"
2018-03-18 20:24:03 +01:00
)
type UIProvider func(gmx Gomuks) GomuksUI
2018-03-18 20:24:03 +01:00
type GomuksUI interface {
Render()
HandleNewPreferences()
2018-05-01 18:17:57 +02:00
OnLogin()
OnLogout()
2018-03-18 20:24:03 +01:00
MainView() MainView
Init()
Start() error
Stop()
Finish()
2018-03-18 20:24:03 +01:00
}
type MainView interface {
GetRoom(roomID string) RoomView
AddRoom(room *rooms.Room)
RemoveRoom(room *rooms.Room)
2018-04-24 15:51:40 +02:00
SetRooms(rooms map[string]*rooms.Room)
2018-03-18 20:24:03 +01:00
UpdateTags(room *rooms.Room)
2018-04-24 01:13:17 +02:00
2018-03-18 20:24:03 +01:00
SetTyping(roomID string, users []string)
NotifyMessage(room *rooms.Room, message Message, should pushrules.PushActionArrayShould)
InitialSyncDone()
2018-03-18 20:24:03 +01:00
}
2018-03-22 22:03:45 +01:00
type RoomView interface {
MxRoom() *rooms.Room
2018-04-21 18:41:19 +02:00
SetCompletions(completions []string)
SetTyping(users []string)
UpdateUserList()
ParseEvent(evt *mautrix.Event) Message
GetEvent(eventID string) Message
2019-04-10 00:04:39 +02:00
AddMessage(message Message)
AddServiceMessage(message string)
}
type Message interface {
ID() string
TxnID() string
2018-05-16 20:42:07 +02:00
SenderID() string
Timestamp() time.Time
NotificationSenderName() string
NotificationContent() string
2019-04-10 00:04:39 +02:00
SetState(state mautrix.OutgoingEventState)
SetIsHighlight(highlight bool)
SetID(id string)
}