1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
|
// Copyright 2019-2022 Graham Clark. All rights reserved. Use of this source
// code is governed by the MIT license that can be found in the LICENSE
// file.
// Package padding provides a widget that pads an inner widget on the sides, above and below
package padding
import (
"errors"
"fmt"
"github.com/gcla/gowid"
"github.com/gcla/gowid/gwutil"
"github.com/gcla/gowid/widgets/fill"
tcell "github.com/gdamore/tcell/v2"
)
//======================================================================
type IWidget interface {
gowid.ICompositeWidget
HAlign() gowid.IHAlignment
Width() gowid.IWidgetDimension
VAlign() gowid.IVAlignment
Height() gowid.IWidgetDimension
}
// Widget renders the wrapped widget with the provided
// width; if the wrapped widget is a box, or the wrapped widget is to be
// packed to a width smaller than specified, the wrapped widget can be
// aligned in the middle, left or right
type Widget struct {
inner gowid.IWidget
vAlign gowid.IVAlignment
height gowid.IWidgetDimension
hAlign gowid.IHAlignment
width gowid.IWidgetDimension
opts Options
Callbacks *gowid.Callbacks
gowid.FocusCallbacks
gowid.SubWidgetCallbacks
}
type Options struct{}
func New(inner gowid.IWidget,
valign gowid.IVAlignment, height gowid.IWidgetDimension,
halign gowid.IHAlignment, width gowid.IWidgetDimension,
opts ...Options) *Widget {
var opt Options
if len(opts) > 0 {
opt = opts[0]
}
res := &Widget{
inner: inner,
vAlign: valign,
height: height,
hAlign: halign,
width: width,
opts: opt,
Callbacks: gowid.NewCallbacks(),
}
//var _ gowid.IWidget = res
//var _ IWidgetSettable = res
return res
}
func (w *Widget) String() string {
return fmt.Sprintf("hpad[%v]", w.SubWidget())
}
func (w *Widget) Selectable() bool {
return w.inner.Selectable()
}
func (w *Widget) SubWidget() gowid.IWidget {
return w.inner
}
func (w *Widget) SetSubWidget(wi gowid.IWidget, app gowid.IApp) {
w.inner = wi
gowid.RunWidgetCallbacks(w.Callbacks, gowid.SubWidgetCB{}, app, w)
}
func (w *Widget) OnSetAlign(f gowid.IWidgetChangedCallback) {
gowid.AddWidgetCallback(w.Callbacks, gowid.HAlignCB{}, f)
}
func (w *Widget) RemoveOnSetAlign(f gowid.IIdentity) {
gowid.RemoveWidgetCallback(w.Callbacks, gowid.HAlignCB{}, f)
}
func (w *Widget) HAlign() gowid.IHAlignment {
return w.hAlign
}
func (w *Widget) SetHAlign(i gowid.IHAlignment, app gowid.IApp) {
w.hAlign = i
gowid.RunWidgetCallbacks(w.Callbacks, gowid.HAlignCB{}, app, w)
}
func (w *Widget) VAlign() gowid.IVAlignment {
return w.vAlign
}
func (w *Widget) SetVAlign(i gowid.IVAlignment, app gowid.IApp) {
w.vAlign = i
gowid.RunWidgetCallbacks(w.Callbacks, gowid.VAlignCB{}, app, w)
}
func (w *Widget) OnSetHeight(f gowid.IWidgetChangedCallback) {
gowid.AddWidgetCallback(w.Callbacks, gowid.WidthCB{}, f)
}
func (w *Widget) RemoveOnSetHeight(f gowid.IIdentity) {
gowid.RemoveWidgetCallback(w.Callbacks, gowid.WidthCB{}, f)
}
func (w *Widget) Width() gowid.IWidgetDimension {
return w.width
}
func (w *Widget) SetWidth(i gowid.IWidgetDimension, app gowid.IApp) {
w.width = i
gowid.RunWidgetCallbacks(w.Callbacks, gowid.WidthCB{}, app, w)
}
func (w *Widget) Height() gowid.IWidgetDimension {
return w.height
}
func (w *Widget) SetHeight(i gowid.IWidgetDimension, app gowid.IApp) {
w.height = i
gowid.RunWidgetCallbacks(w.Callbacks, gowid.HeightCB{}, app, w)
}
func (w *Widget) SubWidgetSize(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize {
size2 := size
// If there is a horizontal offset specified, the relative features should reduce the size of the
// supplied size i.e. it should be relative to the reduced screen size
switch al := w.HAlign().(type) {
case gowid.HAlignLeft:
switch s := size.(type) {
case gowid.IRenderBox:
size2 = gowid.RenderBox{C: s.BoxColumns() - (al.Margin + al.MarginRight), R: s.BoxRows()}
case gowid.IRenderFlowWith:
size2 = gowid.RenderFlowWith{C: s.FlowColumns() - (al.Margin + al.MarginRight)}
default:
}
default:
}
switch al := w.VAlign().(type) {
case gowid.VAlignTop:
switch s := size2.(type) {
case gowid.IRenderBox:
size2 = gowid.RenderBox{C: s.BoxColumns(), R: s.BoxRows() - al.Margin}
}
}
return gowid.ComputeSubSizeUnsafe(size2, w.Width(), w.Height())
}
func (w *Widget) RenderSize(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderBox {
return gowid.CalculateRenderSizeFallback(w, size, focus, app)
}
func (w *Widget) Render(size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas {
return Render(w, size, focus, app)
}
func (w *Widget) UserInput(ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool {
return UserInput(w, ev, size, focus, app)
}
//''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
// func SubWidgetSize(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.IRenderSize {
// size2 := size
// // If there is a horizontal offset specified, the relative features should reduce the size of the
// // supplied size i.e. it should be relative to the reduced screen size
// switch al := w.Align().(type) {
// case gowid.HAlignLeft:
// switch s := size.(type) {
// case gowid.IRenderBox:
// size2 = gowid.RenderBox{C: s.BoxColumns() - al.Margin, R: s.BoxRows()}
// case gowid.IRenderFlowWith:
// size2 = gowid.RenderFlowWith{C: s.FlowColumns() - al.Margin}
// default:
// }
// default:
// }
// return gowid.ComputeHorizontalSubSizeUnsafe(size2, w.Width())
// }
func Render(w IWidget, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) gowid.ICanvas {
subSize := w.SubWidgetSize(size, focus, app)
subWidgetCanvas := w.SubWidget().Render(subSize, focus, app)
subWidgetMaxColumn := subWidgetCanvas.BoxColumns()
var myCols int
if cols, ok := size.(gowid.IColumns); ok {
myCols = cols.Columns()
} else {
myCols = subWidgetMaxColumn
}
if myCols < subWidgetMaxColumn {
// TODO - bad, mandates trimming on right
subWidgetCanvas.TrimRight(myCols)
} else if myCols > subWidgetMaxColumn {
switch al := w.HAlign().(type) {
case gowid.HAlignRight:
subWidgetCanvas.ExtendLeft(gowid.EmptyLine(myCols - subWidgetMaxColumn))
case gowid.HAlignMiddle:
r := (myCols - subWidgetMaxColumn) / 2
l := myCols - (subWidgetMaxColumn + r)
subWidgetCanvas.ExtendRight(gowid.EmptyLine(r))
subWidgetCanvas.ExtendLeft(gowid.EmptyLine(l))
case gowid.HAlignLeft:
l := gwutil.Min(al.Margin, myCols-subWidgetMaxColumn)
r := myCols - (l + subWidgetMaxColumn)
subWidgetCanvas.ExtendRight(gowid.EmptyLine(r))
subWidgetCanvas.ExtendLeft(gowid.EmptyLine(l))
default:
panic(fmt.Errorf("Invalid horizontal alignment setting %v of type %T", al, al))
}
}
maxCol := subWidgetCanvas.BoxColumns()
subWidgetRows := subWidgetCanvas.BoxRows()
fill := fill.NewEmpty()
var rowsToUseInResult int
switch sz := size.(type) {
case gowid.IRenderBox:
rowsToUseInResult = sz.BoxRows()
case gowid.IRenderFlowWith:
switch w.Height().(type) {
case gowid.IRenderFlow, gowid.IRenderFixed, gowid.IRenderWithUnits:
rowsToUseInResult = subWidgetRows
default:
panic(fmt.Errorf("Height spec %v cannot be used in flow mode for %T", w.Height(), w))
}
case gowid.IRenderFixed:
switch w.Height().(type) {
case gowid.IRenderFlow, gowid.IRenderFixed:
rowsToUseInResult = subWidgetRows
switch al := w.VAlign().(type) {
case gowid.VAlignTop:
rowsToUseInResult += al.Margin
}
case gowid.IRenderWithUnits:
rowsToUseInResult = w.Height().(gowid.IRenderWithUnits).Units()
default:
panic(fmt.Errorf("This spec %v of type %T cannot be used in flow mode for %T",
w.Height(), w.Height(), w))
}
default:
panic(fmt.Errorf("Unknown size %v", size))
}
switch al := w.VAlign().(type) {
case gowid.VAlignBottom:
if rowsToUseInResult > subWidgetRows+al.Margin {
bottoml := al.Margin
topl := rowsToUseInResult - (bottoml + subWidgetRows)
fc1 := fill.Render(gowid.RenderBox{C: maxCol, R: topl}, gowid.NotSelected, app)
fc2 := fill.Render(gowid.RenderBox{C: maxCol, R: bottoml}, gowid.NotSelected, app)
fc1.AppendBelow(subWidgetCanvas, true, false)
subWidgetCanvas = fc1
subWidgetCanvas.AppendBelow(fc2, false, false)
} else if rowsToUseInResult > al.Margin {
bottoml := al.Margin
topl := subWidgetRows - (rowsToUseInResult + bottoml)
subWidgetCanvas.Truncate(topl, 0)
fc1 := fill.Render(gowid.RenderBox{C: maxCol, R: bottoml}, gowid.NotSelected, app)
fc1.AppendBelow(subWidgetCanvas, true, false)
subWidgetCanvas = fc1
} else {
subWidgetCanvas = fill.Render(gowid.RenderBox{C: maxCol, R: rowsToUseInResult}, gowid.NotSelected, app)
}
case gowid.VAlignMiddle:
if rowsToUseInResult > subWidgetRows {
topl := (rowsToUseInResult - subWidgetRows) / 2
bottoml := rowsToUseInResult - (topl + subWidgetRows)
fc1 := fill.Render(gowid.RenderBox{C: maxCol, R: topl}, gowid.NotSelected, app)
fc2 := fill.Render(gowid.RenderBox{C: maxCol, R: bottoml}, gowid.NotSelected, app)
fc1.AppendBelow(subWidgetCanvas, true, false)
subWidgetCanvas = fc1
subWidgetCanvas.AppendBelow(fc2, false, false)
} else {
topl := (subWidgetRows - rowsToUseInResult) / 2
bottoml := subWidgetRows - (rowsToUseInResult + topl)
subWidgetCanvas.Truncate(topl, bottoml)
}
case gowid.VAlignTop:
if rowsToUseInResult > subWidgetRows+al.Margin {
topl := al.Margin
bottoml := rowsToUseInResult - (topl + subWidgetRows)
fc1 := fill.Render(gowid.RenderBox{C: maxCol, R: topl}, gowid.NotSelected, app)
fc2 := fill.Render(gowid.RenderBox{C: maxCol, R: bottoml}, gowid.NotSelected, app)
fc1.AppendBelow(subWidgetCanvas, true, false)
subWidgetCanvas = fc1
subWidgetCanvas.AppendBelow(fc2, false, false)
} else if rowsToUseInResult > al.Margin {
topl := al.Margin
bottoml := subWidgetRows - (rowsToUseInResult - al.Margin)
subWidgetCanvas.Truncate(0, bottoml)
fc1 := fill.Render(gowid.RenderBox{C: maxCol, R: topl}, gowid.NotSelected, app)
fc1.AppendBelow(subWidgetCanvas, true, false)
subWidgetCanvas = fc1
} else {
topl := rowsToUseInResult
subWidgetCanvas = fill.Render(gowid.RenderBox{C: maxCol, R: topl}, gowid.NotSelected, app)
}
default:
panic(errors.New("Invalid vertical alignment setting"))
}
gowid.MakeCanvasRightSize(subWidgetCanvas, size)
return subWidgetCanvas
}
// UserInput will adjust the input event's x coordinate depending on the input size
// and widget alignment. If the input is e.g. IRenderFixed, then no adjustment is
// made.
func UserInput(w IWidget, ev interface{}, size gowid.IRenderSize, focus gowid.Selector, app gowid.IApp) bool {
//return false
rSize := gowid.RenderSize(w, size, focus, app)
subSize := w.SubWidgetSize(size, focus, app)
ss := w.SubWidget().RenderSize(subSize, focus, app)
sCols := ss.BoxColumns()
sRows := ss.BoxRows()
//cols2, ok := size.(gowid.IColumns)
cols2 := rSize.BoxColumns()
rows2 := rSize.BoxRows()
var xd int
//if ok {
switch al := w.HAlign().(type) {
case gowid.HAlignRight:
xd = -(cols2 - sCols)
case gowid.HAlignMiddle:
r := (cols2 - sCols) / 2
l := cols2 - (sCols + r)
xd = -l
case gowid.HAlignLeft:
if al.Margin+sCols <= cols2 {
xd = -al.Margin
} else {
xd = -gwutil.Max(0, cols2-sCols)
}
}
var yd int
switch al := w.VAlign().(type) {
case gowid.VAlignBottom:
yd = sRows - rows2
case gowid.VAlignMiddle:
yd = (sRows - rows2) / 2
case gowid.VAlignTop:
if rows2 > sRows+al.Margin {
yd = -al.Margin
} else if rows2 > al.Margin {
yd = -al.Margin
} else {
yd = -(rows2 - 1)
}
}
//}
newev := gowid.TranslatedMouseEvent(ev, xd, yd)
// TODO - don't need to translate event for keyboard event...
if evm, ok := newev.(*tcell.EventMouse); ok {
mx, transY := evm.Position()
if mx >= 0 && mx < sCols {
if transY < sRows && transY >= 0 {
return gowid.UserInputIfSelectable(w.SubWidget(), newev, subSize, focus, app)
}
}
} else {
return gowid.UserInputIfSelectable(w.SubWidget(), newev, subSize, focus, app)
}
return false
}
//======================================================================
// Local Variables:
// mode: Go
// fill-column: 110
// End:
|