Refactor button widgets; add widgets.RadioButton
#5781
+117
−49
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,35 @@ | ||
| -- A 3x1 tile button with a question mark on it. Clicking on it will show help text for a command | ||
|
|
||
| local textures = require('gui.textures') | ||
| local ConfigureButton = require('gui.widgets.buttons.configure_button') | ||
|
|
||
| local help_pen_center = dfhack.pen.parse{ | ||
| tile=curry(textures.tp_control_panel, 9) or nil, ch=string.byte('?')} | ||
|
|
||
| ---------------- | ||
| -- HelpButton -- | ||
| ---------------- | ||
|
|
||
| ---@class widgets.HelpButton.attrs: widgets.ConfigureButton.attrs | ||
| ---@field command? string | ||
|
|
||
| ---@class widgets.HelpButton.attrs.partial: widgets.HelpButton.attrs | ||
|
|
||
| ---@class widgets.HelpButton: widgets.ConfigureButton, widgets.HelpButton.attrs | ||
| ---@field super widgets.ConfigureButton | ||
| ---@field ATTRS widgets.HelpButton.attrs|fun(attributes: widgets.HelpButton.attrs.partial) | ||
| ---@overload fun(init_table: widgets.HelpButton.attrs.partial): self | ||
| HelpButton = defclass(HelpButton, ConfigureButton) | ||
|
Contributor
There was a problem hiding this comment. subclassing there ought to be an abstract class used as the base of |
||
|
|
||
| HelpButton.ATTRS{ | ||
| frame={t=0, r=1, w=3, h=1}, | ||
| command=DEFAULT_NIL, | ||
| pen_center=help_pen_center, | ||
|
Contributor
There was a problem hiding this comment. the overriding not worth holding up the merge over a quibble. |
||
| } | ||
|
|
||
| function HelpButton:init() | ||
| local command = self.command .. ' ' | ||
| self.on_click = function() dfhack.run_command('gui/launcher', command) end | ||
|
Contributor
There was a problem hiding this comment. if line 26 is redundant, then this is as well. but harmless. |
||
| end | ||
|
|
||
| return HelpButton | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| -- A 3x1 tile button that toggles state when clicked | ||
|
|
||
| local textures = require('gui.textures') | ||
| local ConfigureButton = require('gui.widgets.buttons.configure_button') | ||
|
|
||
| local to_pen = dfhack.pen.parse | ||
|
|
||
| local enabled_pen_left = to_pen{fg=COLOR_CYAN, | ||
| tile=curry(textures.tp_control_panel, 1), ch=string.byte('[')} | ||
|
Contributor
There was a problem hiding this comment. I do not believe the |
||
| local enabled_pen_center = to_pen{fg=COLOR_LIGHTGREEN, | ||
| tile=curry(textures.tp_control_panel, 2) or nil, ch=251} -- check | ||
| local enabled_pen_right = to_pen{fg=COLOR_CYAN, | ||
| tile=curry(textures.tp_control_panel, 3) or nil, ch=string.byte(']')} | ||
| local disabled_pen_left = to_pen{fg=COLOR_CYAN, | ||
| tile=curry(textures.tp_control_panel, 4) or nil, ch=string.byte('[')} | ||
| local disabled_pen_center = to_pen{fg=COLOR_RED, | ||
| tile=curry(textures.tp_control_panel, 5) or nil, ch=string.byte('x')} | ||
| local disabled_pen_right = to_pen{fg=COLOR_CYAN, | ||
| tile=curry(textures.tp_control_panel, 6) or nil, ch=string.byte(']')} | ||
|
|
||
| ----------------- | ||
| -- RadioButton -- | ||
| ----------------- | ||
|
|
||
| ---@class widgets.RadioButton.attrs: widgets.ConfigureButton.attrs | ||
| ---@field initial_state boolean | ||
|
|
||
| ---@class widgets.RadioButton.attrs.partial: widgets.RadioButton.attrs | ||
|
|
||
| ---@class widgets.RadioButton: widgets.ConfigureButton, widgets.RadioButton.attrs | ||
| ---@field super widgets.ConfigureButton | ||
| ---@field ATTRS widgets.RadioButton.attrs|fun(attributes: widgets.RadioButton.attrs.partial) | ||
| ---@overload fun(init_table: widgets.RadioButton.attrs.partial): self | ||
| RadioButton = defclass(RadioButton, ConfigureButton) | ||
|
|
||
| RadioButton.ATTRS{ | ||
| initial_state=true, | ||
| } | ||
|
|
||
| function RadioButton:init() | ||
| self.toggle_state = self.initial_state | ||
|
|
||
| self.on_click = function() self.toggle_state = not self.toggle_state end | ||
| self.pen_left = function() return self.toggle_state and enabled_pen_left or disabled_pen_left end | ||
| self.pen_center = function() return self.toggle_state and enabled_pen_center or disabled_pen_center end | ||
| self.pen_right = function() return self.toggle_state and enabled_pen_right or disabled_pen_right end | ||
| end | ||
|
|
||
|
Contributor
There was a problem hiding this comment. no getter function for the toggle state? are users supposed to probe an instance's yeah, that's what the new documenation says. hm. I don't like that. are there other widgets that similarly require looking inside them for state info? also, no callbacks? I guess a user could catch the |
||
| return RadioButton | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is not Bumber's work here, but I think this code is more than a bit strange.
first,
curry()cannot return falsey; it either throws an error or returns a function. accordingly, theor nilclauses don't ever execute.second, that
curry()is used at all. if I understand this construction,tp.control_panel()will be called to get the relevant texpos each time the pen is drawn instead of adding the texture once at module load time with e.g.tile=tp.control_panel(10). I do not know very much about textures, but I would be extremely surprised if the texpos for a control panel texture changes dynamically.and third, that three individual pens are used instead of a three-tile table.I now see that a three-tile Label is created in the postinit stage.myk checked this in a651f64 and he certainly knows more about textures than I do.
anyway, not directly relevant to the PR.