sidebar

Documentation

Overview

Package sidebar contains the sidebar showing guilds and channels.

Index

• type Sidebar
  • func NewSidebar(ctx context.Context) *Sidebar
  • func (s *Sidebar) GuildID() discord.GuildID
  • func (s *Sidebar) OpenDMs() *direct.ChannelView
  • func (s *Sidebar) SelectChannel(chID discord.ChannelID)
  • func (s *Sidebar) SetSelectedGuild(guildID discord.GuildID)
  • func (s *Sidebar) Unselect()

Types

type Sidebar

type Sidebar struct {
	*gtk.Box // horizontal

	Left   *gtk.Box
	DMView *directbutton.View
	Guilds *guilds.View
	Right  *gtk.Stack
	// contains filtered or unexported fields
}

Sidebar is the bar on the left side of the application once it's logged in.

func NewSidebar

func NewSidebar(ctx context.Context) *Sidebar

NewSidebar creates a new Sidebar.

func (*Sidebar) GuildID

func (s *Sidebar) GuildID() discord.GuildID

GuildID returns the guild ID that the channel list is showing for, if any. If not, 0 is returned.

func (*Sidebar) OpenDMs

func (s *Sidebar) OpenDMs() *direct.ChannelView

OpenDMs opens the DMs view. It automatically loads the DMs on first open, so the returned ChannelView is guaranteed to be ready.

func (*Sidebar) SelectChannel

func (s *Sidebar) SelectChannel(chID discord.ChannelID)

SelectChannel selects and activates the channel with the given ID. It ensures that the sidebar is at the right place then activates the controller. This function acts the same as if the user clicked on the channel, meaning it funnels down to a single widget that then floats up to the controller.

func (*Sidebar) SetSelectedGuild

func (s *Sidebar) SetSelectedGuild(guildID discord.GuildID)

SetSelectedGuild marks the guild with the given ID as selected.

func (*Sidebar) Unselect

func (s *Sidebar) Unselect()

Unselect unselects the current guild or channel.