Documentation
¶
Index ¶
- Variables
- func NewDefaultTextView(Buffer *gtk.TextBuffer) *gtk.TextView
- type Blockquote
- type CodeBlock
- type ContainerState
- func (s *ContainerState) Append(block WidgetBlock)
- func (s *ContainerState) Context() context.Context
- func (s *ContainerState) Current() WidgetBlock
- func (s *ContainerState) FinalizeBlock()
- func (s *ContainerState) ForEach(f func(WidgetBlock) bool)
- func (s *ContainerState) Reset()
- func (s *ContainerState) TagTable() *gtk.TextTagTable
- func (s *ContainerState) TextBlock() *TextBlock
- func (s *ContainerState) Walk(f func(WidgetBlock) bool)
- func (s *ContainerState) WithParent(parent *gtk.Box) *ContainerState
- type ContainerWidgetBlock
- type ListItemBlock
- type SeparatorBlock
- type TextBlock
- func (b *TextBlock) ApplyLink(url string, start, end *gtk.TextIter)
- func (b *TextBlock) ConnectLinkHandler()
- func (b *TextBlock) EmptyTag(tagName string) *gtk.TextTag
- func (b *TextBlock) EndLine(amount int)
- func (b *TextBlock) Insert(text string)
- func (b *TextBlock) InsertNewLines(n int)
- func (b *TextBlock) IsNewLine() bool
- func (b *TextBlock) Tag(tagName string) *gtk.TextTag
- func (b *TextBlock) TagBounded(tag *gtk.TextTag, f func())
- func (b *TextBlock) TagNameBounded(tagName string, f func())
- func (b *TextBlock) TextBlock() *TextBlock
- func (b *TextBlock) TrailingNewLines() int
- type TextWidgetBlock
- type Viewer
- type WidgetBlock
Constants ¶
This section is empty.
Variables ¶
var CodeBlockCSS = cssutil.Applier("md-codeblock", `
.md-codeblock.frame {
background-color: alpha(mix(@theme_bg_color, @theme_fg_color, 0.1), 0.5);
}
.md-codeblock scrollbar {
background: none;
border: none;
}
.md-codeblock:active scrollbar {
opacity: 0.2;
}
.md-codeblock:not(.md-codeblock-expanded) scrollbar {
opacity: 0;
}
.md-codeblock-text {
font-family: monospace;
padding: 4px 6px;
padding-bottom: 0px; /* bottom-margin */
}
.md-codeblock-actions > *:not(label) {
background-color: alpha(@theme_bg_color, 0.35);
opacity: 0.5;
padding: 0px 6px;
margin-top: 4px;
margin-right: 4px;
margin-bottom: 4px;
}
.md-codeblock-actions > *:not(label):hover,
.md-codeblock-expanded .md-codeblock-actions > * {
opacity: 1;
}
.md-codeblock-language {
font-family: monospace;
font-size: 0.9em;
margin: 0px 6px;
color: mix(@theme_bg_color, @theme_fg_color, 0.85);
}
/*
* ease-in-out-gradient -steps 5 -min 0.2 -max 0
* ease-in-out-gradient -steps 5 -min 0 -max 75 -f $'%.2fpx\n'
*/
.md-codeblock-voverflow .md-codeblock-cover {
background-image: linear-gradient(
to top,
alpha(@theme_bg_color, 0.25) 0.00px,
alpha(@theme_bg_color, 0.24) 2.40px,
alpha(@theme_bg_color, 0.19) 19.20px,
alpha(@theme_bg_color, 0.06) 55.80px,
alpha(@theme_bg_color, 0.01) 72.60px
);
}
`)
Functions ¶
func NewDefaultTextView ¶
func NewDefaultTextView(Buffer *gtk.TextBuffer) *gtk.TextView
NewDefaultTextView creates a new TextView that TextBlock uses.
Types ¶
type Blockquote ¶
type Blockquote struct {
*gtk.Box
State *ContainerState
}
Blockquote is a widget block that boxes another list of widget blocks. To use it, create a new Blockquote using NewBlockquote with the current ContainerState, then use Blockquote.State to walk further.
func NewBlockquote ¶
func NewBlockquote(current *ContainerState) *Blockquote
NewBlockquote creates a new Blockquote.
type CodeBlock ¶
type CodeBlock struct {
*gtk.Overlay
// contains filtered or unexported fields
}
CodeBlock is a widget containing a block of code.
func NewCodeBlock ¶
func NewCodeBlock(state *ContainerState) *CodeBlock
NewCodeBlock creates a new CodeBlock.
type ContainerState ¶
type ContainerState struct {
*gtk.Box
// Viewer is the top-level Markdown viewer. It is the same for all new
// ContainerStates created underneath the same Viewer.
Viewer *Viewer
// contains filtered or unexported fields
}
ContainerState is the state of a single level of a Markdown node boxed inside a container of widgets.
func (*ContainerState) Append ¶
func (s *ContainerState) Append(block WidgetBlock)
Append appends another block into the container state. The appended block is marked as the current block and will be returned by Current.
func (*ContainerState) Context ¶
func (s *ContainerState) Context() context.Context
Context returns the Viewer's context.
func (*ContainerState) Current ¶
func (s *ContainerState) Current() WidgetBlock
Current returns the current WidgetBlock instance.
func (*ContainerState) FinalizeBlock ¶
func (s *ContainerState) FinalizeBlock()
FinalizeBlock finalizes the current block. Any later use of the state must create a new block.
func (*ContainerState) ForEach ¶
func (s *ContainerState) ForEach(f func(WidgetBlock) bool)
ForEach iterates over the current-level containers until f returns true.
func (*ContainerState) Reset ¶
func (s *ContainerState) Reset()
Reset clears the container state and removes all widgets from the parent box.
func (*ContainerState) TagTable ¶
func (s *ContainerState) TagTable() *gtk.TextTagTable
TagTable returns the Viewer's TagTable.
func (*ContainerState) TextBlock ¶
func (s *ContainerState) TextBlock() *TextBlock
TextBlock returns either the current widget if it's a Text widget (*TextBlock or TextWidgetBlock), or it creates a new *TextBlock.
func (*ContainerState) Walk ¶
func (s *ContainerState) Walk(f func(WidgetBlock) bool)
Walk is like ForEach, except all ContainerWidgetBlocks are traversed recursively.
func (*ContainerState) WithParent ¶
func (s *ContainerState) WithParent(parent *gtk.Box) *ContainerState
WithParent creates a new ContainerState with the given parent widget and a new list. The Viewer is retained.
type ContainerWidgetBlock ¶
type ContainerWidgetBlock interface {
WidgetBlock
State() *ContainerState
}
ContainerWidgetBlock is a WidgetBlock that also embeds other WidgetBlocks. It should be implemented by embedding
type ListItemBlock ¶
type ListItemBlock struct {
*gtk.Box
ListIndex *int // nil if unordered
// contains filtered or unexported fields
}
ListItemBlock is a text block that contains a list item.
func NewListItemBlock ¶
func NewListItemBlock(state *ContainerState, listIndex *int, offset int) *ListItemBlock
NewListItemBlock creates a new ListItemBlock.
func (*ListItemBlock) TextBlock ¶
func (b *ListItemBlock) TextBlock() *TextBlock
TextBlock returns the underlying TextBlock.
type SeparatorBlock ¶
type SeparatorBlock struct {
*gtk.Separator
}
SeparatorBlock is a horizontal line block.
func NewSeparatorBlock ¶
func NewSeparatorBlock() *SeparatorBlock
NewSeparatorBlock creates a new SeparatorBlock.
type TextBlock ¶
type TextBlock struct {
*gtk.TextView
// Iter is the text block's internal iterator. Use this while walking to
// insert texts. All methods that act on the block will also use this
// iterator.
Iter *gtk.TextIter
// Buffer is the TextView's TextBuffer.
Buffer *gtk.TextBuffer
// contains filtered or unexported fields
}
func NewTextBlock ¶
func NewTextBlock(state *ContainerState) *TextBlock
NewTextBlock creates a new TextBlock.
func NewTextBlockFromView ¶
func NewTextBlockFromView(view *gtk.TextView, state *ContainerState) *TextBlock
NewTextBlockFromView creates a new TextBlock from the given TextView.
func (*TextBlock) ConnectLinkHandler ¶
func (b *TextBlock) ConnectLinkHandler()
ConnectLinkHandler connects the hyperlink handler into the TextBlock. Call this method if the TextBlock has a link. Only the first call will bind the handler.
func (*TextBlock) EmptyTag ¶
EmptyTag gets an existing tag or creates a new empty one with the given name.
func (*TextBlock) EndLine ¶
EndLine ensures that the given amount of new lines will be put before the iterator. It accounts for existing new lines in the Bufferfer.
func (*TextBlock) InsertNewLines ¶
InsertNewLines inserts n new lines without checking for existing new lines. Most users should use EndLine instead. If n < 1, then no insertion is done.
func (*TextBlock) Tag ¶
Tag returns a tag from the md.Tags table. One is added if it's not already in the shared TagsTable.
func (*TextBlock) TagBounded ¶
func (b *TextBlock) TagBounded(tag *gtk.TextTag, f func())
TagBounded saves the current offset and calls f, expecting the function to use s.iter. Then, the tag with the given name is applied on top.
func (*TextBlock) TagNameBounded ¶
TagNameBounded wraps around TagBounded and HTMLTag.
func (*TextBlock) TextBlock ¶
TextBlock returns itself. It impleemnts the TextWidgetChild interface.
func (*TextBlock) TrailingNewLines ¶
TrailingNewLines counts the number of trailing new lines up to 2.
type TextWidgetBlock ¶
type TextWidgetBlock interface {
WidgetBlock
TextBlock() *TextBlock
}
TextWidgetBlock is a WidgetBlock that also embeds a TextBlock. All children that has appendable texts should implement this.
type Viewer ¶
type Viewer struct {
*gtk.Box
// contains filtered or unexported fields
}
Viewer is a widget that renders a Markdown AST node into widgets. All widgets within the viewer are strictly immutable. A Viewer itself is a ContainerWidgetBlock.
func (*Viewer) SetExtraMenu ¶
func (v *Viewer) SetExtraMenu(model gio.MenuModeller)
SetExtraMenu sets the given menu for all children widget nodes.
func (*Viewer) State ¶
func (v *Viewer) State() *ContainerState
State returns the Viewer's ContainerState. It implements ContainerWidgetBlock.
type WidgetBlock ¶
type WidgetBlock interface {
gtk.Widgetter
}
WidgetBlock describes the minimum interface of a child within the widget tree.
Source Files