Expand description
The screens of a business application, generated from the model in ravenrs-app.
use ravenrs_app::BusinessObject;
use ravenrs_app_ui::App;
#[derive(BusinessObject)]
#[object(navigation = "Records")]
struct Account {
#[field(key)]
id: i64,
name: String,
}
let window = App::new("Accounts").entity::<Account>().build()?;
let mut ui = ravenrs_widgets::Ui::new(window, ravenrs_style::Theme::raven_dark());
ui.update();Modules§
- ids
- The ids of the actions of
SystemModule.
Structs§
- Action
Button - One action as a button of its own, for a screen that places its commands itself.
- Action
Container - A place on the screen for actions of some categories: what is in place shows, what is off shows faded, and what does not fit folds into a menu. Keys work while it shows.
- App
- An application from its records: the module with the actions every application needs, the screens, and records in memory unless told otherwise.
- AppShell
- A whole application window, generated from its model.
- Catalog
- Texts by language and by key.
- Clone
Module - Clones what its entity says can be: what a record holds comes along, a reference points to the same record, and only a list marked as belonging to the record is cloned with it. Everything else is left out, so it does not copy a whole graph by accident.
- Dashboard
View - Several views together, each in a frame of its own, as the model says. A dashboard is bound to no records, and people can move and resize its pieces.
- Detail
View - The form of the record being edited. What each field uses comes from the model’s
Editor. - Editor
Registry - Which control edits which kind of field, by name. The model’s
Editorsetting picks one, so a field can change its control without touching code. - Editor
Request - What a control is being asked for.
- Entity
Form - A form of an entity in a window. It checks its rules and hands the record over: keeping it is up to whoever asked, so a record with rules of its own keeps going through them. A handle.
- Entity
Pane - A list of an entity’s records beside a form that adds or changes them, with a button on each row to open it and one to take it away. It fits inside a screen an application made itself.
- Form
Text - What the window of a form says.
- List
Editor Request - What a list editor is asked to show: the records as the list reads them, and how to act on them.
- List
View - The records of an entity in a grid: search, filters, sorting and export come with it. Opening a row opens its form.
- Main
Template - Navigation on the side, commands above the view.
- Model
Editor - The application’s model, for whoever may change it.
- Pane
Words - What a pane says about its records.
- Secured
App - An application people sign in to, each seeing what their roles allow.
- Session
- What the screens of a running application share: the frame, the current form, and what has to happen next. A handle.
- System
Module - The actions every application needs. Searching, filtering and exporting a list come with
DataGrid, and are not repeated here. - Template
Parts - The pieces of a window, for a template to arrange.
- Texts
- The texts of a catalog in one language.
- Words
- The words the generated screens use.
Enums§
- Language
- A language the screens can be in.
Constants§
- CALENDAR_
EDITOR - The name of the editor that shows a list on the days of a month.
- CHART_
EDITOR - The name of the editor that shows a list as a chart.
- SCHEDULER_
EDITOR - The name of the editor that shows a list on a timeline, a row per resource.
- TREE_
EDITOR - The name of the editor that shows a list as a tree.
Traits§
- Frame
Template - Arranges a window. Replacing it changes the whole look of an application, and nothing else.
Functions§
- chart_
view - A chart of these records, from settings given directly, as a panel of its own wants it: the
same names
CHART_EDITORreads from the model. - live_
expose - Registers this crate’s types with a playground’s interpreter (feature
live). - summary_
text - What these records come to, for one
field:Sum, in words: money as money, and a count of the records with no field.
Type Aliases§
- Cell
Text - What a cell says instead of its value, for a field and a record; nothing means its value.
- Collection
Source - Gives the records of a collection with no storage, from the record that has it.
- Column
Shape - What a column ends up as, from its field and the one the field gives.
- Form
Caption - Says what a field of a form is called, for a field and the record as it stands, when that depends on the record; nothing means the usual.
- Grid
Shape - What a grid ends up as, from the one the list made.
- List
Source - What gives a list its records when no storage keeps them.
- Open
Handler - What opening a row of a list does, with its key.