Merge 9f5fa37 into 495eaa4

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- The Button widget.
 - A function that draws text vertically.
 - The LineChart widget can display X axis labels in vertical orientation.
 - The LineChart widget allows the user to specify a custom scale for the Y
@@ -34,10 +35,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   subscriber.
 - The infrastructure now throttles event driven screen redraw rather than
   redrawing for each input event.
-- Widgets can now specify the scope at which they want to receive keyboard
-  events, i.e. KeyScopeNone for no events, KeyScopeFocused to receive events
-  only if the parent container is focused and KeyScopeGlobal to receive all
-  keyboard events.
+- Widgets can now specify the scope at which they want to receive keyboard and
+  mouse events.
 
 #### Breaking API changes
 
@@ -55,8 +54,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   distribution system. This shouldn't affect users as the removed methods
   aren't needed by container users.
 - The widgetapi.Options struct now uses an enum instead of a boolean when
-  widget specifies if it wants keyboard events. This affects development of new
-  widgets.
+  widget specifies if it wants keyboard or mouse events. This only impacts
+  development of new widgets.
 
 ### Fixed
 

README.md

@@ -8,7 +8,7 @@
 
 # termdash
 
-[<img src="./images/termdashdemo_0_6_0.gif" alt="termdashdemo" type="image/gif">](termdashdemo/termdashdemo.go)
+[<img src="./images/termdashdemo_0_7_0.gif" alt="termdashdemo" type="image/gif">](termdashdemo/termdashdemo.go)
 
 This project implements a cross-platform customizable terminal based dashboard.
 The feature set is inspired by the
@@ -62,6 +62,18 @@ Project documentation is available in the [doc](doc/) directory.
 
 ## Implemented Widgets
 
+### The Button
+
+Allows users to interact with the application, each button press runs a callback function.
+Run the
+[buttondemo](widgets/button/buttondemo/buttondemo.go).
+
+```go
+go run github.com/mum4k/termdash/widgets/button/buttondemo/buttondemo.go
+```
+
+[<img src="./images/buttondemo.gif" alt="buttondemo" type="image/gif">](widgets/button/buttondemo/buttondemo.go)
+
 ### The Gauge
 
 Displays the progress of an operation. Run the

canvas/braille/braille_test.go

@@ -295,7 +295,7 @@ func TestBraille(t *testing.T) {
 			wantErr: true,
 		},
 		{
-			desc: "SetCellOptions sets the cell options in full area",
+			desc: "SetAreaCellOptions sets the cell options in full area",
 			ar:   image.Rect(0, 0, 1, 1),
 			pixelOps: func(c *Canvas) error {
 				return c.SetAreaCellOpts(image.Rect(0, 0, 1, 1), cell.FgColor(cell.ColorRed), cell.BgColor(cell.ColorBlue))
@@ -315,7 +315,7 @@ func TestBraille(t *testing.T) {
 			},
 		},
 		{
-			desc: "SetCellOptions sets the cell options in a sub-area",
+			desc: "SetAreaCellOptions sets the cell options in a sub-area",
 			ar:   image.Rect(0, 0, 3, 3),
 			pixelOps: func(c *Canvas) error {
 				return c.SetAreaCellOpts(image.Rect(0, 0, 2, 2), cell.FgColor(cell.ColorRed), cell.BgColor(cell.ColorBlue))

canvas/canvas.go

@@ -21,6 +21,7 @@ import (
 
 	"github.com/mum4k/termdash/area"
 	"github.com/mum4k/termdash/cell"
+	"github.com/mum4k/termdash/cell/runewidth"
 	"github.com/mum4k/termdash/terminalapi"
 )
 
@@ -94,6 +95,72 @@ func (c *Canvas) Cell(p image.Point) (*cell.Cell, error) {
 	return c.buffer[p.X][p.Y].Copy(), nil
 }
 
+// SetCellOpts sets options on the specified cell of the canvas without
+// modifying the content of the cell.
+// Sets the default cell options if no options are provided.
+// This method is idempotent.
+func (c *Canvas) SetCellOpts(p image.Point, opts ...cell.Option) error {
+	curCell, err := c.Cell(p)
+	if err != nil {
+		return err
+	}
+
+	if len(opts) == 0 {
+		// Set the default options.
+		opts = []cell.Option{
+			cell.FgColor(cell.ColorDefault),
+			cell.BgColor(cell.ColorDefault),
+		}
+	}
+	if _, err := c.SetCell(p, curCell.Rune, opts...); err != nil {
+		return err
+	}
+	return nil
+}
+
+// SetAreaCells is like SetCell, but sets the specified rune and options on all
+// the cells within the provided area.
+// This method is idempotent.
+func (c *Canvas) SetAreaCells(cellArea image.Rectangle, r rune, opts ...cell.Option) error {
+	haveArea := c.Area()
+	if !cellArea.In(haveArea) {
+		return fmt.Errorf("unable to set cell runes in area %v, it must fit inside the available cell area is %v", cellArea, haveArea)
+	}
+
+	rw := runewidth.RuneWidth(r)
+	for row := cellArea.Min.Y; row < cellArea.Max.Y; row++ {
+		for col := cellArea.Min.X; col < cellArea.Max.X; {
+			p := image.Point{col, row}
+			if col+rw > cellArea.Max.X {
+				break
+			}
+			cells, err := c.SetCell(p, r, opts...)
+			if err != nil {
+				return err
+			}
+			col += cells
+		}
+	}
+	return nil
+}
+
+// SetAreaCellOpts is like SetCellOpts, but sets the specified options on all
+// the cells within the provided area.
+func (c *Canvas) SetAreaCellOpts(cellArea image.Rectangle, opts ...cell.Option) error {
+	haveArea := c.Area()
+	if !cellArea.In(haveArea) {
+		return fmt.Errorf("unable to set cell options in area %v, it must fit inside the available cell area is %v", cellArea, haveArea)
+	}
+	for col := cellArea.Min.X; col < cellArea.Max.X; col++ {
+		for row := cellArea.Min.Y; row < cellArea.Max.Y; row++ {
+			if err := c.SetCellOpts(image.Point{col, row}, opts...); err != nil {
+				return err
+			}
+		}
+	}
+	return nil
+}
+
 // setCellFunc is a function that sets cell content on a terminal or a canvas.
 type setCellFunc func(image.Point, rune, ...cell.Option) error