view

type AllAuthenticators []Authenticator

type AnyAuthenticator []Authenticator

type Authenticator interface {
	// Authenticate returns the auth result in ok,
	// err is used for real errors not negative authentication
	Authenticate(context *Context) (ok bool, err error)
}

type BasicAuth struct {
	Realm        string
	UserPassword map[string]string
}

type BoolAuth bool

type Button struct {
	ViewBaseWithId
	Name     string
	Value    interface{}
	Submit   bool
	Class    string
	Disabled bool
	TabIndex int
}

type CSRFProtector interface {
	ExtraFormField() View
	Validate(context *Context) (ok bool, err error)
}

type Canvas struct {
	ViewBaseWithId
	Class  string
	Width  int
	Height int
}

type Checkbox struct {
	ViewBaseWithId
	Name     string
	Label    string
	Checked  bool
	Disabled bool
	Class    string
}

type Configuration struct {
	TemplateSystem     templatesystem.Implementation
	Page               PageConfiguration
	Form               FormConfiguration
	BaseDirs           []string
	StaticDirs         []string
	TemplateDirs       []string
	RedirectSubdomains []string // Exapmle: "www"
	BaseURL            string
	SiteName           string
	CookieSecret       string
	SessionTracker     SessionTracker
	SessionDataStore   SessionDataStore
	OnPreAuth          func(context *Context) error
	GlobalAuth         Authenticator // Will allways be used before all other authenticators
	FallbackAuth       Authenticator // Will be used when no other authenticator is defined for the view
	LoginSignupPage    **Page
	// Middlewares               []Middleware
	Debug struct {
		Mode           bool
		PrintPaths     bool
		PrintRedirects bool
	}
}

type ContactFormModel struct {
	Name    model.String `gostart:"label=Your name|maxlen=40"`
	Email   model.Email  `gostart:"label=Your email address|required|maxlen=40"`
	Subject model.String `gostart:"label=Subject|maxlen=40"`
	Message model.Text   `gostart:"label=Your message|required|cols=40|rows=10"`
}

type Context struct {
	*web.Context

	// View that responds to the HTTP request
	RespondingView View

	// Arguments parsed from the URL path
	PathArgs []string

	/*
		Cached user object of the session.
		User won't be set automatically, use user.OfSession(context) instead.

		Example for setting it automatically for every request:

			import "github.com/ungerik/go-start/user"

			Config.OnPreAuth = func(context *Context) error {
				user.OfSession(context) // Sets context.User
				return nil
			}
	*/
	User interface{}

	// Custom request wide data that can be set by the application
	Data interface{}
	// contains filtered or unexported fields
}

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

type CookieSessionTracker struct {
}

type Div struct {
	ViewBaseWithId
	Class   string
	Content View
}

type DummyImage struct {
	ViewBaseWithId
	Class           string
	Width           int
	Height          int
	BackgroundColor string
	ForegroundColor string
	Text            string
}

type DynamicView func(context *Context) (view View, err error)

type EscapeStringsListModel []string

type EscapeStringsTableModel [][]string

type Forbidden string

type Form struct {
	ViewBaseWithId
	Class         string
	Action        string // Default is "." plus any URL params
	Method        string
	FormID        string
	CSRFProtector CSRFProtector
	Layout        FormLayout       // Config.DefaultFormLayout will be used if nil
	FieldFactory  FormFieldFactory // Config.DefaultFormFieldFactory will be used if nil
	// Static content rendered before the dynamic form fields
	// that are generated via GetModel()
	StaticContent View
	GetModel      GetFormModelFunc
	// If redirect result is non nil, it will be used instead of Form.Redirect
	OnSubmit            func(form *Form, formModel interface{}, context *Context) (redirect URL, err error)
	ModelMaxDepth       int      // if zero, no depth limit
	ExcludeFields       []string // Use point notation for nested fields
	DisableFields       []string // Use point notation for nested fields
	RequireFields       []string // Also available as static struct field tag. Use point notation for nested fields
	ErrorMessageClass   string   // If empty, Config.Form.DefaultErrorMessageClass will be used
	SuccessMessageClass string   // If empty, Config.Form.DefaultSuccessMessageClass will be used
	RequiredMarker      View     // If nil, Config.Form.DefaultRequiredMarker will be used
	SuccessMessage      string
	SubmitButtonText    string
	SubmitButtonClass   string
	Redirect            URL // 302 redirect after successful Save()
	ShowRefIDs          bool
}

type FormConfiguration struct {
	DefaultLayout              FormLayout
	DefaultFieldFactory        FormFieldFactory
	DefaultCSRFProtector       CSRFProtector
	DefaultErrorMessageClass   string
	DefaultSuccessMessageClass string
	DefaultSubmitButtonClass   string
	DefaultRequiredMarker      View
	NumFieldRepeatMessage      int
}

type FormFieldFactory interface {
	NewInput(form *Form, data interface{}, metaData *model.MetaData) View
	NewLabel(form *Form, forView View, data interface{}, metaData *model.MetaData) View
	NewFieldErrorMessage(form *Form, message string, metaData *model.MetaData) View
	NewFormErrorMessage(form *Form, message string) View
	NewSuccessMessage(form *Form, message string) View
	NewSubmitButton(form *Form, text string) View
	NewAddSliceItemButton(form *Form) View
	NewRemoveSliceItemButton(form *Form) View
}

type FormLayout interface {
	NewField_old(form *Form, modelValue model.Value, metaData *model.MetaData, errors []*model.ValidationError) View

	BeforeFormContent(form *Form) View
	AfterFormContent(form *Form) View

	BeforeStruct(form *Form, data interface{}, metaData *model.MetaData) View
	StructField(form *Form, data interface{}, metaData *model.MetaData) View
	AfterStruct(form *Form, data interface{}, metaData *model.MetaData) View

	BeforeArray(form *Form, data interface{}, metaData *model.MetaData) View
	ArrayField(form *Form, data interface{}, metaData *model.MetaData) View
	AfterArray(form *Form, data interface{}, metaData *model.MetaData) View

	BeforeSlice(form *Form, data interface{}, metaData *model.MetaData) View
	SliceField(form *Form, data interface{}, metaData *model.MetaData) View
	AfterSlice(form *Form, data interface{}, metaData *model.MetaData) View
}

type Format struct {
	ViewBase
	Text   string
	Args   []interface{}
	Escape bool
}

type GetFormModelFunc func(form *Form, context *Context) (model interface{}, err error)

type GetModelIteratorFunc func(context *Context) model.Iterator

type GetModelViewFunc func(model interface{}, context *Context) (view View, err error)

type GetTemplateContextFunc func(requestContext *Context) (context interface{}, err error)

type HTML string

type HTMLStringsListModel []string

type HTMLStringsTableModel [][]string

type HiddenInput struct {
	ViewBaseWithId
	Name  string
	Value string
}

type If struct {
	ViewBaseWithId
	Condition   bool
	Content     View
	ElseContent View
}

type Iframe struct {
	ViewBaseWithId
	Class        string
	Width        int
	Height       int
	Border       int
	Scrolling    bool
	MarginWidth  int
	MarginHeight int
	Seamless     bool
	URL          string
}

type Image struct {
	ViewBaseWithId
	Class       string
	URL         string
	Width       int
	Height      int
	Description string
}

type IndexedStringsSelectModel struct {
	Options []string
	Index   int
}

type IterateChildrenCallback func(parent View, child View) (next bool)

type Label struct {
	ViewBaseWithId
	Class   string
	For     View
	Content View
}

type Link struct {
	ViewBaseWithId
	Class     string
	Model     LinkModel
	NewWindow bool
}

type LinkModel interface {
	URL
	LinkContent(context *Context) View
	LinkTitle(context *Context) string
	LinkRel(context *Context) string
}

type List struct {
	ViewBaseWithId
	Model       ListModel
	Ordered     bool
	OrderOffset uint
	Class       string
}

type ListModel interface {
	NumItems() int
	ItemView(index int, context *Context) (view View, err error)
}

type Menu struct {
	ViewBaseWithId
	Class           string
	ItemClass       string
	ActiveItemClass string
	BetweenItems    string
	Items           []LinkModel
	Reverse         bool
}

type Middleware interface {
	PreRender(context *Context) (abort bool)
	PostRender(context *Context, html string, err error) (newHtml string, newErr error)
}

type ModelView struct {
	ViewBase
	GetModelIterator GetModelIteratorFunc
	GetModelView     GetModelViewFunc // nil Views will be ignored
}

type MultiViewsListModel []Views

type NotFound string

type NotFoundView struct {
	ViewBase
	Message string
}

type Page struct {
	Template

	// Called before any other function when rendering the page
	OnPreRender func(page *Page, context *Context) (err error)

	// Writes the head title tag (HTML escaped)
	WriteTitle PageWriteFunc

	// Writes the head meta description tag (HTML escaped)
	WriteMetaDescription PageWriteFunc

	// Content of the head meta viewport tag,
	// Config.Page.DefaultMetaViewport will be used if ""
	MetaViewport string

	// Write additional HTML head content
	WriteHead PageWriteFunc

	// Write head content before the stylesheet link
	WritePreCSS PageWriteFunc

	// stylesheet link URL
	CSS URL

	// Write head content after the stylesheet link
	WritePostCSS PageWriteFunc

	// Write scripts as last element of the HTML head
	WriteHeadScripts PageWriteFunc

	// HTML body content. Will be wrapped by a div with class="container"
	Content View

	// Write scripts after body content
	WriteScripts PageWriteFunc

	// That way of linking to favicons my be removed in the future:
	Favicon16x16URL   string
	Favicon57x57URL   string
	Favicon72x72URL   string
	Favicon114x114URL string
	Favicon129x129URL string
	// contains filtered or unexported fields
}

type PageConfiguration struct {
	Template                string
	DefaultWriteHead        PageWriteFunc // will be called after WriteTitle
	DefaultCSS              string
	DefaultMetaViewport     string
	DefaultWriteHeadScripts PageWriteFunc // write scripts as last element of the HTML head
	DefaultWriteScripts     PageWriteFunc // will be called if Page.WriteScripts is nil
	PostWriteScripts        PageWriteFunc // will always be called after Page.WriteScripts
	DefaultAuth             Authenticator // Will be used for pages with Page.NeedsAuth == true
}

type PageLink struct {
	Page    **Page
	Content View   // If is nil, then self.LinkTitle() will be used
	Title   string // If is "", then self.Page.LinkTitle(context) will be used
	Rel     string
}

type PageWriteFunc func(context *Context, writer io.Writer) (err error)

type Paragraph struct {
	ViewBaseWithId
	Class   string
	Content View
}

type PermanentRedirect string

type Redirect string

type RedirectView struct {
	ViewBase
	URL       string
	Permanent bool
}

type RenderView func(context *Context, writer *utils.XMLWriter) error

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

type Response struct {
	utils.XMLBuffer
	// contains filtered or unexported fields
}

type Select struct {
	ViewBaseWithId
	Model    SelectModel
	Name     string
	Size     int // 0 shows all items, 1 shows a dropdownbox, other values show size items
	Class    string
	Disabled bool
}

type SelectModel interface {
	NumOptions() int
	Value(index int) string
	Selected(index int) bool
	Disabled(index int) bool
	RenderItem(index int, context *Context, writer *utils.XMLWriter) (err error)
	IterateChildren(parent *Select, callback func(parent View, child View) (next bool))
}

type Session struct {
}

type SessionDataStore interface {
	Get(context *Context, data interface{}) (ok bool, err error)
	Set(context *Context, data interface{}) (err error)
	Delete(context *Context) (err error)
}

type SessionTracker interface {
	ID(context *Context) (id string, ok bool)
	SetID(context *Context, id string)
	DeleteID(context *Context)
}

type ShortTag struct {
	ViewBase
	Tag     string
	Class   string
	Attribs map[string]string
	Content View
}

type Span struct {
	ViewBaseWithId
	Class   string
	Content View
}

type StandardFormFieldFactory struct {
}

type StaticFile struct {
	ViewBase
	Filename       string // Will set file extension at ContentType
	ContentTypeExt string
	// contains filtered or unexported fields
}

type StringLink struct {
	Url     string
	Content View   // If is nil, then self.LinkTitle() will be used
	Title   string // If is "", then self.URL will be used
	Rel     string
}

type StringURL string

type StringsSelectModel struct {
	Options        []string
	SelectedOption string
}

type Table struct {
	ViewBaseWithId
	Model     TableModel
	Class     string
	Caption   string
	HeaderRow bool
}

type TableModel interface {
	Rows() int
	Columns() int
	CellView(row int, column int, context *Context) (view View, err error)
}

type TableModelView struct {
	ViewBase
	Class             string
	Caption           string
	GetModelIterator  GetModelIteratorFunc
	GetHeaderRowViews func(context *Context) (views Views, err error)
	GetRowViews       func(row int, rowModel interface{}, context *Context) (views Views, err error)
	// contains filtered or unexported fields
}

type Tag struct {
	ViewBaseWithId
	Tag        string
	Content    View
	Class      string
	Attribs    map[string]string
	ExtraClose bool
}

type Template struct {
	ViewBase
	Filename       string // Will set file extension at ContentType
	Text           string
	ContentTypeExt string
	GetContext     GetTemplateContextFunc
	TemplateSystem templatesystem.Implementation // If nil, self.App.Config.TemplateSystem is used
	// contains filtered or unexported fields
}

type TextArea struct {
	ViewBaseWithId
	Text     string
	Name     string
	Cols     int
	Rows     int
	Readonly bool
	Disabled bool
	TabIndex int
	Class    string
}

type TextField struct {
	ViewBaseWithId
	Text      string
	Name      string
	Size      int
	MaxLength int
	Type      TextFieldType
	Readonly  bool
	Disabled  bool
	TabIndex  int
	Class     string
}

type TextFieldType int

type TextPreview struct {
	ViewBase
	PlainText   string
	MaxLength   int
	ShortLength int // Shortened length if len(Text) > MaxLength. If zero, MaxLength will be used
	MoreLink    LinkModel
}

type URL interface {
	// If args are passed, they will be used instead of context.PathArgs.
	URL(context *Context, args ...string) string
}

type URLLink struct {
	Url     URL
	Content View   // If is nil, then self.LinkTitle() will be used
	Title   string // If is "", then self.URL will be used
	Rel     string
}

type VerticalFormLayout struct {
}

type Video struct {
	ViewBaseWithId
	Class  string
	URL    string
	Width  int
	Height int
}

type View interface {
	Init(thisView View)
	ID() string
	IterateChildren(callback IterateChildrenCallback)
	// Everything written to out will be discarded if there was an error
	// out.Write() is not expected to return errors like bytes.Buffer
	Render(context *Context, writer *utils.XMLWriter) (err error)
}

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

type ViewBaseWithId struct {
	ViewBase
	// contains filtered or unexported fields
}

type ViewPath struct {
	Name   string
	Args   int
	View   View
	Auth   Authenticator
	NoAuth URL
	Sub    []ViewPath // Only allowed when View is a Page or nil
}

type ViewURLWrapper struct {
	View View
	// contains filtered or unexported fields
}

type ViewWithURL interface {
	View
	URL
	SetPath(path string)
}

type Views []View

type ViewsListModel []View

type ViewsTableModel []Views