editor

Documentation

Overview

Package editor provides editors for the various file types. These generally take the form of a window which displays a single widget, as well as some context-sensitive menu for the main menu bar.

Index

• type Editor
• type EditorBase
  • func New(path *common.PathEntry, x, y float32, project *hsproject.Project) *EditorBase
  • func (e *EditorBase) Cleanup()
  • func (e *EditorBase) EncodeState() []byte
  • func (e *EditorBase) GetID() string
  • func (e *EditorBase) GetWindowTitle() string
  • func (e *EditorBase) HasChanges(editor Saveable) bool
  • func (e *EditorBase) Save(editor Saveable)
  • func (e *EditorBase) State() state.EditorState
• type Saveable

Types

type Editor

type Editor interface {
	window.Renderable
	window.MainMenuUpdater

	// HasFocus returns true if editor is focused
	HasFocus() (hasFocus bool)
	// GetWindowTitle controls what the window title for this editor appears as
	GetWindowTitle() string
	// Show sets Visible to true
	Show()
	// SetVisible can be used to set Visible to false if the editor should be closed
	SetVisible(bool)
	// GetID returns a unique identifier for this editor window
	GetID() string
	// BringToFront brings this editor to the front of the application, giving it focus
	BringToFront()
	// State returns the current state of this editor, in a JSON-serializable struct
	State() state.EditorState
	// Save writes any changes made in the editor to the file that is open in the editor.
	Save()

	Size(float32, float32) *giu.WindowWidget
}

EditorWindow represents editor window

type EditorBase

type EditorBase struct {
	*window.Window
	Path    *common.PathEntry
	Project *hsproject.Project
}

EditorBase represents an editor

func New

func New(path *common.PathEntry, x, y float32, project *hsproject.Project) *EditorBase

New creates a new editor

func (*EditorBase) Cleanup

func (e *EditorBase) Cleanup()

Cleanup cides an editor

func (*EditorBase) EncodeState

func (e *EditorBase) EncodeState() []byte

EncodeState returns widget's state (unique for each editor type) in byte slice format

func (*EditorBase) GetID

func (e *EditorBase) GetID() string

GetID returns editors ID

func (*EditorBase) GetWindowTitle

func (e *EditorBase) GetWindowTitle() string

GetWindowTitle returns window title

func (*EditorBase) HasChanges

func (e *EditorBase) HasChanges(editor Saveable) bool

HasChanges returns true if editor has changed data

func (*EditorBase) Save

func (e *EditorBase) Save(editor Saveable)

Save saves an editor

func (*EditorBase) State

func (e *EditorBase) State() state.EditorState

State returns editors state

type Saveable

type Saveable interface {
	// GenerateSaveData is called by the underlying interface (namely editor.Editor) to retrieve the data
	// the editor wants written to the file.
	GenerateSaveData() []byte
}

Saveable denotes a struct that has data that can be saved to a file.