1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Portable UI API for the _app.nit_ framework
21 import linux
::ui
is conditional
(linux
)
22 import android
::ui
is conditional
(android
)
23 import ios
::ui
is conditional
(ios
)
28 # The current `Window` of this activity
30 # This attribute must be set by refinements of `App`.
31 var window
: Window is writable
33 redef fun on_create
do window
.on_create
35 redef fun on_start
do window
.on_start
37 redef fun on_resume
do window
.on_resume
39 redef fun on_pause
do window
.on_pause
41 redef fun on_stop
do window
.on_stop
43 redef fun on_destroy
do window
.on_destroy
45 redef fun on_restore_state
do window
.on_restore_state
47 redef fun on_save_state
do window
.on_save_state
50 # An event created by an `AppComponent` and sent to `AppObserver`s
54 # Observer of `AppEvent`s raised by `AppComponent`s
56 # Notification of `event` raised by `sender`
58 # To be implemented in subclasses as needed.
59 fun on_event
(event
: AppEvent) do end
62 redef class AppComponent
65 # All `AppObserver` notified of events raised by `self`
67 # By default, only `self` is an observer.
68 # Any other `AppObserver` can be added to this collection.
69 var observers
= new HashSet[AppObserver].from
([self: AppObserver])
71 # Propagate `event` to all `observers` by calling `AppObserver::on_event`
72 fun notify_observers
(event
: AppEvent)
74 for observer
in observers
do
75 observer
.on_event
(event
)
80 # A control implementing the UI
84 # Direct parent `Control` in the control tree
86 # If `null` then `self` is at the root of the tree, or not yet attached.
87 var parent
: nullable CompositeControl = null is private writable(set_parent
)
89 # Direct parent `Control` in the control tree
91 # Setting `parent` calls `remove` on the old parent and `add` on the new one.
92 fun parent
=(parent
: nullable CompositeControl)
94 var old_parent
= self.parent
95 if old_parent
!= null and old_parent
!= parent
then
96 old_parent
.remove
self
99 if parent
!= null then parent
.add
self
105 # A `Control` grouping other controls
106 class CompositeControl
109 protected var items
= new Array[Control]
111 # Add `item` as a child of `self`
112 protected fun add
(item
: Control) do items
.add item
114 # Remove `item` from `self`
115 fun remove
(item
: Control) do if has
(item
) then items
.remove item
117 # Is `item` in `self`?
118 fun has
(item
: Control): Bool do return items
.has
(item
)
120 # Remove all items from `self`
121 fun clear
do for item
in items
.to_a
do remove item
123 redef fun on_create
do for i
in items
do i
.on_create
125 redef fun on_start
do for i
in items
do i
.on_start
127 redef fun on_resume
do for i
in items
do i
.on_resume
129 redef fun on_pause
do for i
in items
do i
.on_pause
131 redef fun on_stop
do for i
in items
do i
.on_stop
133 redef fun on_destroy
do for i
in items
do i
.on_destroy
135 redef fun on_restore_state
do for i
in items
do i
.on_restore_state
137 redef fun on_save_state
do for i
in items
do i
.on_save_state
140 # A window, root of the `Control` tree
142 super CompositeControl
145 # A viewable `Control`
149 # Is this control enabled so the user can interact with it?
151 # By default, or if set to `null`, the control is enabled.
152 var enabled
: nullable Bool is writable, abstract, autoinit
155 # A control with some `text`
156 abstract class TextView
159 # Main `Text` of this control
161 # By default, or if set to `null`, no text is shown.
162 var text
: nullable Text is writable, abstract, autoinit
164 # Set the relative size of the text
166 # A value of 1.0, the default, use the platform default text size.
167 # Values under 1.0 set a smaller text size, and over 1.0 a larger size.
169 # Implementation varies per platform, and some controls may be unaffected
170 # depending on the customization options of each platform.
171 # For consistent results, it is recommended to use only on instances
172 # of `Label` and `size` should be either 0.5, 1.0 or 1.5.
173 fun size
=(size
: nullable Float) is autoinit
do end
175 # Align the text horizontally
177 # Use 0.0 to align left (the default), 0.5 to align in the center and
178 # 1.0 to align on the right.
180 # Implementation varies per platform, and some controls may be unaffected
181 # depending on the customization options of each platform.
182 # For consistent results, it is recommended to use only on instances
183 # of `Label` and `size` should be either 0.0, 0.5 or 1.0.
184 fun align
=(center
: nullable Float) is autoinit
do end
187 # A control for the user to enter custom `text`
191 # Hide password or any content entered in this view?
192 var is_password
: nullable Bool is writable
195 # A pushable button, raises `ButtonPressEvent`
205 # Toggle control with two states and a label
209 # Is this control in the checked/on state?
210 var is_checked
= false is writable
213 # A `Button` press event
214 class ButtonPressEvent
217 # The `Button` that raised this event
221 # A layout to visually organize `Control`s
222 abstract class Layout
224 super CompositeControl
227 # An horizontal linear organization
228 class HorizontalLayout
232 # A vertical linear organization
237 # Scrollable list of views in a simple list
240 super CompositeControl