home
classes/clusters list
class information
+
Point of view
ANY
ANY
SUI_INTERFACE_ROOT
SUI_ROOT
SUI_PANEL
SUI_CONTAINER
TYPED_INTERNALS
INTERNALS_HANDLER
All features
class SUI_FORM
Summary
top
A form is a bunch of widgets (let's say a
"window"
)
Direct parents
inherit list:
SUI_WIDGET
Class invariant
top
name
/= Void
Overview
top
creation features
make
(a_name:
STRING
)
exported features
Form construction
set_title
(a_title:
STRING
)
menu
:
SUI_MENU_BAR
set_menu
(a_menu:
SUI_MENU_BAR
)
panel
:
SUI_PANEL
set_panel
(a_panel:
SUI_PANEL
)
Form flow
next
:
STRING
set_next
(a_next:
STRING
)
parent
:
SUI_CONTAINER
is_connected
:
BOOLEAN
set_factory
(a_factory:
SUI_FACTORY
)
Installs the UI
factory
.
factory
:
SUI_FACTORY
The installed UI
factory
.
Screen life cycle:
new_screen
,
enable
,
disable
,
end_screen
.
screen
:
SUI_ROOT
The root, which contains one or more forms
new_screen
Create a new (modal)
screen
enable
(home: SUI_FORM)
Starts catching events for the
screen
disable
Stops catching events for the
screen
end_screen
Destroys the
screen
is_enabled
:
BOOLEAN
Is the
screen
catching events?
on_stop
(stop_action:
PROCEDURE
[
TUPLE
])
name
:
STRING
set_title
(a_title:
STRING
)
effective procedure
top
require
not
is_connected
menu
:
SUI_MENU_BAR
writable attribute
top
set_menu
(a_menu:
SUI_MENU_BAR
)
effective procedure
top
require
a_menu /=
menu
not
is_connected
ensure
menu
= a_menu
panel
:
SUI_PANEL
writable attribute
top
set_panel
(a_panel:
SUI_PANEL
)
effective procedure
top
require
a_panel /=
panel
not
is_connected
ensure
panel
= a_panel
next
:
STRING
effective function
top
require
is_connected
set_next
(a_next:
STRING
)
effective procedure
top
require
a_next /= Void
is_connected
ensure
next
.is_equal(a_next)
parent
:
SUI_CONTAINER
writable attribute
top
is_connected
:
BOOLEAN
effective function
top
set_factory
(a_factory:
SUI_FACTORY
)
once procedure
top
Installs the UI
factory
.
It can be called only once.
require
a_factory /= Void
ensure
factory
= a_factory
factory
:
SUI_FACTORY
effective function
top
The installed UI
factory
.
screen
:
SUI_ROOT
effective function
top
The root, which contains one or more forms
require
initialized:
factory
/= Void
new_screen
effective procedure
top
Create a new (modal)
screen
require
no_screen_or_enabled:
screen
= Void or else
is_enabled
initialized:
factory
/= Void
ensure
screen
/= Void
not
is_enabled
enable
(home: SUI_FORM)
effective procedure
top
Starts catching events for the
screen
require
screen
/= Void
disabled:
not
is_enabled
initialized:
factory
/= Void
ensure
finishes_when_disabled:
not
is_enabled
disable
effective procedure
top
Stops catching events for the
screen
require
is_enabled
initialized:
factory
/= Void
ensure
disabled:
not
is_enabled
end_screen
effective procedure
top
Destroys the
screen
require
screen
/= Void
disabled:
not
is_enabled
initialized:
factory
/= Void
ensure
no_screen_or_enabled:
screen
/= Void implies
is_enabled
is_enabled
:
BOOLEAN
effective function
top
Is the
screen
catching events?
require
initialized:
factory
/= Void
ensure
Result implies
screen
/= Void
on_stop
(stop_action:
PROCEDURE
[
TUPLE
])
effective procedure
top
name
:
STRING
writable attribute
top