mirror of
https://github.com/saymrwulf/xous-core.git
synced 2026-11-19 09:00:54 +00:00
a little more cleanup/re-org
This commit is contained in:
parent
ca8bead919
commit
20fd465acd
1 changed files with 81 additions and 80 deletions
|
|
@ -1,53 +1,5 @@
|
||||||
//! The main API entry point is the `Modal` struct. Click into the struct for more details.
|
//! The main API entry point is the `Modal` struct. Click into the struct for more details.
|
||||||
|
|
||||||
/*
|
|
||||||
design ideas
|
|
||||||
|
|
||||||
Modal for password request:
|
|
||||||
---------------------
|
|
||||||
| Password Type: Updater
|
|
||||||
| Requester: RootKeys
|
|
||||||
| Reason: The updater modal has not been set.
|
|
||||||
| Security Level: Critical
|
|
||||||
|
|
|
||||||
| *****4f_
|
|
||||||
|
|
|
||||||
| ← 👁️ 🕶️ * →
|
|
||||||
|--------------------
|
|
||||||
|
|
||||||
Item primitives:
|
|
||||||
- text bubble
|
|
||||||
- text entry field (with confidentiality option)
|
|
||||||
- left/right radio select
|
|
||||||
- up/down radio select
|
|
||||||
|
|
||||||
Then simple menu prompt after password entry:
|
|
||||||
---------------------
|
|
||||||
| [x] Persist until reboot
|
|
||||||
| [ ] Persist until suspend
|
|
||||||
| [ ] Use once
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
General form for modals:
|
|
||||||
|
|
||||||
[top text]
|
|
||||||
|
|
||||||
[action form]
|
|
||||||
|
|
||||||
[bottom text]
|
|
||||||
|
|
||||||
- "top text" is an optional TextArea
|
|
||||||
- "action form" is a mandatory field that handles interactions
|
|
||||||
- "bottom text" is an optional TextArea
|
|
||||||
|
|
||||||
Action form can be exactly one of the following:
|
|
||||||
- password text field - enter closes the form, has visibility options as left/right arrows; entered text wraps
|
|
||||||
- regular text field - enter closes the form, visibility is always visible; entered text wraps
|
|
||||||
- radio buttons - has an explicit "okay" button to close the modal; up/down arrows + select/enter pick the radio
|
|
||||||
- check boxes - has an explicit "okay" button to close the modal; up/down arrows + select/enter checks boxes
|
|
||||||
- slider - left/right moves the slider, enter/select closes the modal
|
|
||||||
*/
|
|
||||||
|
|
||||||
mod textentry;
|
mod textentry;
|
||||||
pub use textentry::*;
|
pub use textentry::*;
|
||||||
mod radiobuttons;
|
mod radiobuttons;
|
||||||
|
|
@ -67,19 +19,46 @@ use enum_dispatch::enum_dispatch;
|
||||||
|
|
||||||
use crate::api::*;
|
use crate::api::*;
|
||||||
use crate::Gam;
|
use crate::Gam;
|
||||||
|
use crate::MsgForwarder;
|
||||||
|
|
||||||
use graphics_server::api::*;
|
use graphics_server::api::*;
|
||||||
pub use graphics_server::GlyphStyle;
|
pub use graphics_server::GlyphStyle;
|
||||||
|
|
||||||
use xous_ipc::{String, Buffer};
|
use xous_ipc::{String, Buffer};
|
||||||
use num_traits::*;
|
use num_traits::*;
|
||||||
|
|
||||||
use crate::MsgForwarder;
|
|
||||||
|
|
||||||
use core::fmt::Write;
|
use core::fmt::Write;
|
||||||
|
|
||||||
pub const MAX_ITEMS: usize = 8;
|
pub const MAX_ITEMS: usize = 8;
|
||||||
|
|
||||||
|
#[enum_dispatch(ActionApi)]
|
||||||
|
#[derive(Copy, Clone)]
|
||||||
|
pub enum ActionType {
|
||||||
|
TextEntry,
|
||||||
|
RadioButtons,
|
||||||
|
CheckBoxes,
|
||||||
|
Slider,
|
||||||
|
Notification,
|
||||||
|
ConsoleInput
|
||||||
|
}
|
||||||
|
|
||||||
|
#[enum_dispatch]
|
||||||
|
pub trait ActionApi {
|
||||||
|
fn height(&self, glyph_height: i16, margin: i16) -> i16 {glyph_height + margin * 2}
|
||||||
|
fn redraw(&self, _at_height: i16, _modal: &Modal) { unimplemented!() }
|
||||||
|
fn close(&mut self) {}
|
||||||
|
fn is_password(&self) -> bool { false }
|
||||||
|
/// navigation is one of '∴' | '←' | '→' | '↑' | '↓'
|
||||||
|
fn key_action(&mut self, _key: char) -> (Option<xous_ipc::String::<512>>, bool) {(None, true)}
|
||||||
|
fn set_action_opcode(&mut self, _op: u32) {}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, num_derive::FromPrimitive, num_derive::ToPrimitive)]
|
||||||
|
pub enum ModalOpcode { // if changes are made here, also update MenuOpcode
|
||||||
|
Redraw = 0x4000_0000, // set the high bit so that "standard" enums don't conflict with the Modal-specific opcodes
|
||||||
|
Rawkeys,
|
||||||
|
Quit,
|
||||||
|
}
|
||||||
|
|
||||||
/// We use a new type for item names, so that it's easy to resize this as needed.
|
/// We use a new type for item names, so that it's easy to resize this as needed.
|
||||||
#[derive(Debug, Copy, Clone, rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)]
|
#[derive(Debug, Copy, Clone, rkyv::Archive, rkyv::Serialize, rkyv::Deserialize)]
|
||||||
pub struct ItemName(String::<64>);
|
pub struct ItemName(String::<64>);
|
||||||
|
|
@ -161,28 +140,6 @@ impl CheckBoxPayload {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[enum_dispatch]
|
|
||||||
pub trait ActionApi {
|
|
||||||
fn height(&self, glyph_height: i16, margin: i16) -> i16 {glyph_height + margin * 2}
|
|
||||||
fn redraw(&self, _at_height: i16, _modal: &Modal) { unimplemented!() }
|
|
||||||
fn close(&mut self) {}
|
|
||||||
fn is_password(&self) -> bool { false }
|
|
||||||
/// navigation is one of '∴' | '←' | '→' | '↑' | '↓'
|
|
||||||
fn key_action(&mut self, _key: char) -> (Option<xous_ipc::String::<512>>, bool) {(None, true)}
|
|
||||||
fn set_action_opcode(&mut self, _op: u32) {}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[enum_dispatch(ActionApi)]
|
|
||||||
#[derive(Copy, Clone)]
|
|
||||||
pub enum ActionType {
|
|
||||||
TextEntry,
|
|
||||||
RadioButtons,
|
|
||||||
CheckBoxes,
|
|
||||||
Slider,
|
|
||||||
Notification,
|
|
||||||
ConsoleInput
|
|
||||||
}
|
|
||||||
|
|
||||||
//#[derive(Debug)]
|
//#[derive(Debug)]
|
||||||
pub struct Modal<'a> {
|
pub struct Modal<'a> {
|
||||||
pub sid: xous::SID,
|
pub sid: xous::SID,
|
||||||
|
|
@ -210,13 +167,6 @@ pub struct Modal<'a> {
|
||||||
bot_memoized_height: Option<i16>,
|
bot_memoized_height: Option<i16>,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, num_derive::FromPrimitive, num_derive::ToPrimitive)]
|
|
||||||
pub enum ModalOpcode { // if changes are made here, also update MenuOpcode
|
|
||||||
Redraw = 0x4000_0000, // set the high bit so that "standard" enums don't conflict with the Modal-specific opcodes
|
|
||||||
Rawkeys,
|
|
||||||
Quit,
|
|
||||||
}
|
|
||||||
|
|
||||||
fn recompute_canvas(modal: &mut Modal, action: ActionType, top_text: Option<&str>, bot_text: Option<&str>, style: GlyphStyle) {
|
fn recompute_canvas(modal: &mut Modal, action: ActionType, top_text: Option<&str>, bot_text: Option<&str>, style: GlyphStyle) {
|
||||||
// we need to set a "max" size to our modal box, so that the text computations don't fail later on
|
// we need to set a "max" size to our modal box, so that the text computations don't fail later on
|
||||||
let current_bounds = modal.gam.get_canvas_bounds(modal.canvas).expect("couldn't get current bounds");
|
let current_bounds = modal.gam.get_canvas_bounds(modal.canvas).expect("couldn't get current bounds");
|
||||||
|
|
@ -554,3 +504,54 @@ impl<'a> Modal<'a> {
|
||||||
recompute_canvas(self, action, top_text, bot_text, style);
|
recompute_canvas(self, action, top_text, bot_text, style);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
old notes to remind myself of how I got here.
|
||||||
|
|
||||||
|
design ideas
|
||||||
|
|
||||||
|
Modal for password request:
|
||||||
|
---------------------
|
||||||
|
| Password Type: Updater
|
||||||
|
| Requester: RootKeys
|
||||||
|
| Reason: The updater modal has not been set.
|
||||||
|
| Security Level: Critical
|
||||||
|
|
|
||||||
|
| *****4f_
|
||||||
|
|
|
||||||
|
| ← 👁️ 🕶️ * →
|
||||||
|
|--------------------
|
||||||
|
|
||||||
|
Item primitives:
|
||||||
|
- text bubble
|
||||||
|
- text entry field (with confidentiality option)
|
||||||
|
- left/right radio select
|
||||||
|
- up/down radio select
|
||||||
|
|
||||||
|
Then simple menu prompt after password entry:
|
||||||
|
---------------------
|
||||||
|
| [x] Persist until reboot
|
||||||
|
| [ ] Persist until suspend
|
||||||
|
| [ ] Use once
|
||||||
|
---------------------
|
||||||
|
|
||||||
|
General form for modals:
|
||||||
|
|
||||||
|
[top text]
|
||||||
|
|
||||||
|
[action form]
|
||||||
|
|
||||||
|
[bottom text]
|
||||||
|
|
||||||
|
- "top text" is an optional TextArea
|
||||||
|
- "action form" is a mandatory field that handles interactions
|
||||||
|
- "bottom text" is an optional TextArea
|
||||||
|
|
||||||
|
Action form can be exactly one of the following:
|
||||||
|
- password text field - enter closes the form, has visibility options as left/right arrows; entered text wraps
|
||||||
|
- regular text field - enter closes the form, visibility is always visible; entered text wraps
|
||||||
|
- radio buttons - has an explicit "okay" button to close the modal; up/down arrows + select/enter pick the radio
|
||||||
|
- check boxes - has an explicit "okay" button to close the modal; up/down arrows + select/enter checks boxes
|
||||||
|
- slider - left/right moves the slider, enter/select closes the modal
|
||||||
|
*/
|
||||||
Loading…
Reference in a new issue