golib

package module
v0.0.30 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 6, 2024 License: BSD-3-Clause Imports: 7 Imported by: 0

README

pgui-go

Go language module for Pronto!GUI

Generating the protobuf code

In the project folder:

make

Setting up the gRPC tools

go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2

Add to ~/.zshrc or ~/.zprofile

export PATH="$PATH:$(go env GOPATH)/bin"

Refer to gRPC website for latest instructions: https://grpc.io/docs/languages/go/quickstart/

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Check added in v0.0.16 

type Check struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*Check) Checked added in v0.0.16 

func (check *Check) Checked() bool

func (*Check) Embodiment added in v0.0.27 

func (check *Check) Embodiment() string

func (*Check) Label added in v0.0.16 

func (check *Check) Label() string

func (*Check) PrepareForUpdates added in v0.0.16 

func (check *Check) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*Check) SetChecked added in v0.0.16 

func (check *Check) SetChecked(b bool)

func (*Check) SetEmbodiment added in v0.0.27 

func (check *Check) SetEmbodiment(s string)

func (*Check) SetLabel added in v0.0.16 

func (check *Check) SetLabel(s string)

type CheckWith added in v0.0.17 

type CheckWith struct {
	Checked    bool
	Embodiment string
	Label      string
}

func (CheckWith) Make added in v0.0.17 

func (w CheckWith) Make() *Check

Makes a new Check with specified field values.

type Choice added in v0.0.16 

type Choice struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*Choice) Choice added in v0.0.16 

func (choice *Choice) Choice() string

func (*Choice) Choices added in v0.0.16 

func (choice *Choice) Choices() []string

func (*Choice) Embodiment added in v0.0.27 

func (choice *Choice) Embodiment() string

func (*Choice) PrepareForUpdates added in v0.0.16 

func (choice *Choice) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*Choice) SetChoice added in v0.0.16 

func (choice *Choice) SetChoice(s string)

func (*Choice) SetChoices added in v0.0.16 

func (choice *Choice) SetChoices(sa []string)

func (*Choice) SetChoicesVA added in v0.0.16 

func (choice *Choice) SetChoicesVA(sa ...string)

Set the Choices field using variadic string arguments.

func (*Choice) SetEmbodiment added in v0.0.27 

func (choice *Choice) SetEmbodiment(s string)

type ChoiceWith added in v0.0.17 

type ChoiceWith struct {
	Choice     string
	Choices    []string
	Embodiment string
}

func (ChoiceWith) Make added in v0.0.17 

func (w ChoiceWith) Make() *Choice

type Command added in v0.0.10 

type Command struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*Command) Embodiment added in v0.0.27 

func (cmd *Command) Embodiment() string

func (*Command) Label added in v0.0.10 

func (cmd *Command) Label() string

func (*Command) PrepareForUpdates added in v0.0.10 

func (cmd *Command) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*Command) SetEmbodiment added in v0.0.27 

func (cmd *Command) SetEmbodiment(s string)

func (*Command) SetLabel added in v0.0.11 

func (cmd *Command) SetLabel(s string)

func (*Command) SetStatus added in v0.0.11 

func (cmd *Command) SetStatus(i int)

func (*Command) Status added in v0.0.10 

func (cmd *Command) Status() int

type CommandWith added in v0.0.17 

type CommandWith struct {
	Embodiment string
	Label      string
	Status     int
}

func (CommandWith) Make added in v0.0.17 

func (w CommandWith) Make() *Command

Makes a new Command with specified field values.

type FieldRef added in v0.0.11 

type FieldRef struct {
	// contains filtered or unexported fields
}

type Frame added in v0.0.29 

type Frame struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*Frame) FrameItems added in v0.0.29 

func (frame *Frame) FrameItems() []primitive.Interface

func (*Frame) LocateNextDescendant added in v0.0.30 

func (frame *Frame) LocateNextDescendant(locator *key.PKeyLocator) primitive.Interface

TODO: generalize this code by handling inside primitive Reserved area.

func (*Frame) PrepareForUpdates added in v0.0.29 

func (frame *Frame) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*Frame) SetFrameItems added in v0.0.29 

func (frame *Frame) SetFrameItems(items []primitive.Interface)

func (*Frame) SetFrameItemsVA added in v0.0.29 

func (frame *Frame) SetFrameItemsVA(items ...primitive.Interface)

type FrameWith added in v0.0.29 

type FrameWith struct {
	Embodiment string
	Showing    bool
	FrameItems []primitive.Interface
}

func (FrameWith) Make added in v0.0.29 

func (w FrameWith) Make() *Frame

type Group added in v0.0.16 

type Group struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*Group) Embodiment added in v0.0.27 

func (grp *Group) Embodiment() string

func (*Group) GroupItems added in v0.0.16 

func (grp *Group) GroupItems() []primitive.Interface

func (*Group) LocateNextDescendant added in v0.0.27 

func (grp *Group) LocateNextDescendant(locator *key.PKeyLocator) primitive.Interface

TODO: generalize this code by handling inside primitive Reserved area.

func (*Group) PrepareForUpdates added in v0.0.16 

func (grp *Group) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*Group) SetEmbodiment added in v0.0.27 

func (grp *Group) SetEmbodiment(s string)

func (*Group) SetGroupItems added in v0.0.16 

func (grp *Group) SetGroupItems(items []primitive.Interface)

func (*Group) SetGroupItemsVA added in v0.0.16 

func (grp *Group) SetGroupItemsVA(items ...primitive.Interface)

type GroupWith added in v0.0.17 

type GroupWith struct {
	Embodiment string
	GroupItems []primitive.Interface
}

func (GroupWith) Make added in v0.0.17 

func (w GroupWith) Make() *Group

type List added in v0.0.25 

type List struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*List) Embodiment added in v0.0.27 

func (list *List) Embodiment() string

func (*List) ListItems added in v0.0.25 

func (list *List) ListItems() []primitive.Interface

func (*List) LocateNextDescendant added in v0.0.27 

func (list *List) LocateNextDescendant(locator *key.PKeyLocator) primitive.Interface

TODO: generalize this code by handling inside primitive Reserved area.

func (*List) PrepareForUpdates added in v0.0.25 

func (list *List) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*List) Selected added in v0.0.25 

func (list *List) Selected() int

func (*List) SetEmbodiment added in v0.0.27 

func (list *List) SetEmbodiment(s string)

func (*List) SetListItems added in v0.0.25 

func (list *List) SetListItems(items []primitive.Interface)

func (*List) SetListItemsVA added in v0.0.25 

func (list *List) SetListItemsVA(items ...primitive.Interface)

func (*List) SetSelected added in v0.0.25 

func (list *List) SetSelected(selected int)

func (*List) SetTemplateItem added in v0.0.27 

func (list *List) SetTemplateItem(item primitive.Interface)

func (*List) TemplateItem added in v0.0.27 

func (list *List) TemplateItem() primitive.Interface

type ListWith added in v0.0.25 

type ListWith struct {
	Embodiment   string
	ListItems    []primitive.Interface
	Selected     int
	TemplateItem primitive.Interface
}

func (ListWith) Make added in v0.0.25 

func (w ListWith) Make() *List

type ProntoGUI added in v0.0.11 

type ProntoGUI interface {
	StartServing(addr string, port int) error
	StopServing()
	SetGUI(primitives ...primitive.Interface)
	Wait() (updatedPrimitive primitive.Interface, waitError error)
}

func NewProntoGUI added in v0.0.11 

func NewProntoGUI() ProntoGUI

type Reserved added in v0.0.10 

type Reserved struct {
	// contains filtered or unexported fields
}

Reserved fields for primitive updates.

func (*Reserved) EgestUpdate added in v0.0.11 

func (r *Reserved) EgestUpdate(fullupdate bool, fkeys []key.FKey) map[any]any

func (*Reserved) IngestUpdate added in v0.0.11 

func (r *Reserved) IngestUpdate(update map[any]any) error

func (*Reserved) InternalPrepareForUpdates added in v0.0.27 

func (r *Reserved) InternalPrepareForUpdates(pkey key.PKey, onset key.OnSetFunction, getFields func() []FieldRef)

func (*Reserved) LocateNextDescendant added in v0.0.27 

func (r *Reserved) LocateNextDescendant(locator *key.PKeyLocator) primitive.Interface

type Synchro added in v0.0.11 

type Synchro struct {
	// contains filtered or unexported fields
}

func NewSynchro added in v0.0.11 

func NewSynchro() *Synchro

func (*Synchro) GetFullUpdate added in v0.0.11 

func (s *Synchro) GetFullUpdate() ([]byte, error)

func (*Synchro) GetPartialUpdate added in v0.0.11 

func (s *Synchro) GetPartialUpdate() ([]byte, error)

func (*Synchro) GetTopPrimitives added in v0.0.11 

func (s *Synchro) GetTopPrimitives() []primitive.Interface

func (*Synchro) IngestUpdate added in v0.0.11 

func (s *Synchro) IngestUpdate(updatesCbor []byte) (updatedPrimitive primitive.Interface, updateError error)

func (*Synchro) OnSet added in v0.0.11 

func (s *Synchro) OnSet(pkey key.PKey, fkey key.FKey, structural bool)

func (*Synchro) SetTopPrimitives added in v0.0.11 

func (s *Synchro) SetTopPrimitives(primitives ...primitive.Interface)

type Text added in v0.0.15 

type Text struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*Text) Content added in v0.0.15 

func (txt *Text) Content() string

func (*Text) Embodiment added in v0.0.27 

func (txt *Text) Embodiment() string

func (*Text) PrepareForUpdates added in v0.0.15 

func (txt *Text) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*Text) SetContent added in v0.0.15 

func (txt *Text) SetContent(s string)

func (*Text) SetEmbodiment added in v0.0.27 

func (txt *Text) SetEmbodiment(s string)

type TextField added in v0.0.28 

type TextField struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*TextField) Embodiment added in v0.0.28 

func (txt *TextField) Embodiment() string

func (*TextField) PrepareForUpdates added in v0.0.28 

func (txt *TextField) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*TextField) SetEmbodiment added in v0.0.28 

func (txt *TextField) SetEmbodiment(s string)

func (*TextField) SetTextEntry added in v0.0.28 

func (txt *TextField) SetTextEntry(s string)

func (*TextField) TextEntry added in v0.0.28 

func (txt *TextField) TextEntry() string

type TextFieldWith added in v0.0.28 

type TextFieldWith struct {
	TextEntry  string
	Embodiment string
}

func (TextFieldWith) Make added in v0.0.28 

func (w TextFieldWith) Make() *TextField

type TextWith added in v0.0.18 

type TextWith struct {
	Content    string
	Embodiment string
}

func (TextWith) Make added in v0.0.18 

func (w TextWith) Make() *Text

type Tristate added in v0.0.16 

type Tristate struct {
	// Mix-in the common guts for primitives
	Reserved
	// contains filtered or unexported fields
}

func (*Tristate) Embodiment added in v0.0.27 

func (tri *Tristate) Embodiment() string

func (*Tristate) Label added in v0.0.16 

func (tri *Tristate) Label() string

func (*Tristate) PrepareForUpdates added in v0.0.16 

func (tri *Tristate) PrepareForUpdates(pkey key.PKey, onset key.OnSetFunction)

func (*Tristate) SetEmbodiment added in v0.0.27 

func (tri *Tristate) SetEmbodiment(s string)

func (*Tristate) SetLabel added in v0.0.16 

func (tri *Tristate) SetLabel(s string)

func (*Tristate) SetState added in v0.0.16 

func (tri *Tristate) SetState(i int)

func (*Tristate) State added in v0.0.16 

func (tri *Tristate) State() int

type TristateWith added in v0.0.17 

type TristateWith struct {
	Embodiment string
	Label      string
	State      int
}

func (TristateWith) Make added in v0.0.17 

func (w TristateWith) Make() *Tristate

type Update added in v0.0.11 

type Update struct {
	// contains filtered or unexported fields
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.