channels

Documentation

Index

• Constants
• type Banner
  • func NewBanner(ctx context.Context, guildID discord.GuildID) *Banner
  • func (b *Banner) HasBanner() bool
  • func (b *Banner) Invalidate()
  • func (b *Banner) SetScrollOpacity(scrollY float64) (scrolled bool)
  • func (b *Banner) SetURL(url string)
• type ChannelIcon
  • func NewChannelIcon(ch *discord.Channel, overrides ...ChannelIconOverrideFunc) *ChannelIcon
• type ChannelIconOverrideFunc
• type View
  • func NewView(ctx context.Context, guildID discord.GuildID) *View
  • func (v *View) GuildID() discord.GuildID
  • func (v *View) InvalidateHeader()
  • func (v *View) SelectChannel(selectID discord.ChannelID) bool

Constants

const ChannelsWidth = bannerWidth

Types

type Banner

type Banner struct {
	*gtk.Overlay
	Shadows *gtk.Box
	Picture *onlineimage.Picture
	// contains filtered or unexported fields
}

Banner is the guild banner display on top of the channel view.

func NewBanner

func NewBanner(ctx context.Context, guildID discord.GuildID) *Banner

NewBanner creates a new Banner.

func (*Banner) HasBanner

func (b *Banner) HasBanner() bool

HasBanner returns true if the banner is visible.

func (*Banner) Invalidate

func (b *Banner) Invalidate()

Invalidate invalidates and updates the Banner image.

func (*Banner) SetScrollOpacity

func (b *Banner) SetScrollOpacity(scrollY float64) (scrolled bool)

SetScrollOpacity sets the opacity of the shadow depending on the scroll level. If the scroll goes past the banner, then scrolled is true.

func (*Banner) SetURL

func (b *Banner) SetURL(url string)

type ChannelIcon

type ChannelIcon struct {
	*gtk.Widget
	Icon *gtk.Image
}

ChannelIcon is a widget that displays a channel's icon. This does not handle DM channels, as it does not display avatars. It is only for displaying the channel icon.

func NewChannelIcon

func NewChannelIcon(ch *discord.Channel, overrides ...ChannelIconOverrideFunc) *ChannelIcon

NewChannelIcon creates a new ChannelIcon. If ch is nil, the icon will be a special unknown icon.

type ChannelIconOverrideFunc

type ChannelIconOverrideFunc func(t discord.ChannelType) (string, bool)

type View

type View struct {
	*adw.ToolbarView

	Header struct {
		*adw.HeaderBar
		Name *gtk.Label
	}

	Scroll *gtk.ScrolledWindow
	Child  struct {
		*gtk.Box
		Banner *Banner
		View   *gtk.ListView
	}
	// contains filtered or unexported fields
}

View holds the entire channel sidebar containing all the categories, channels and threads.

func NewView

func NewView(ctx context.Context, guildID discord.GuildID) *View

NewView creates a new View.

func (*View) GuildID

func (v *View) GuildID() discord.GuildID

GuildID returns the view's guild ID.

func (*View) InvalidateHeader

func (v *View) InvalidateHeader()

InvalidateHeader invalidates the guild name and banner.

func (*View) SelectChannel

func (v *View) SelectChannel(selectID discord.ChannelID) bool

SelectChannel selects a known channel. If none is known, then it is selected later when the list is changed or never selected if the user selects something else.