Index

Package: Widgets.Progress_Boards

Description

package Widgets.Progress_Boards is

Classes

PBoard_Action

type PBoard_Action is new Action with private;

Ancestors:

Primitive operations:

Actions.Construct (Inherited)

References:

widgets-progress_boards.ads:10:10 (declaration)
widgets-progress_boards.adb:94:41 (reference)
widgets-progress_boards.adb:460:59 (reference)
widgets-progress_boards.ads:11:40 (reference)
widgets-progress_boards.ads:94:10 (full declaration)

Progress_Board

type Progress_Board is new Widget and Process with private;

Ancestors:

Primitive operations:

Add_Listener
Add_Listener
Construct
Delete (overriding Widgets.Delete)
Dispatch_Action
Draw_Content (overriding Widgets.Draw_Content)
Get_Min_Height (overriding Widgets.Get_Min_Height)
Get_Min_Width (overriding Widgets.Get_Min_Width)
Get_Process_Name (overriding Processes.Get_Process_Name)
Objects.Construct (Inherited)
Objects.Object_Read (Inherited)
Objects.Object_Write (Inherited)
Remove_Listener
Set_Ancients
Set_Blue_Key
Set_Green_Key
Set_Location
Set_Next_Life
Set_Yellow_Key
Tick (overriding Processes.Tick)
Widgets.Activate_Popup (Inherited)
Widgets.Adjust (Inherited)
Widgets.Bring_To_Front (Inherited)
Widgets.Construct (Inherited)
Widgets.Deactivate_Popup (Inherited)
Widgets.Draw (Inherited)
Widgets.Find_Widget (Inherited)
Widgets.Get_Color (Inherited)
Widgets.Get_View (Inherited)
Widgets.Get_Window (Inherited)
Widgets.Handle_Ancestor_Hidden (Inherited)
Widgets.Handle_Ancestor_Unhidden (Inherited)
Widgets.Handle_Blur (Inherited)
Widgets.Handle_Click (Inherited)
Widgets.Handle_Descendant_Hidden (Inherited)
Widgets.Handle_Descendant_Unhidden (Inherited)
Widgets.Handle_Enter (Inherited)
Widgets.Handle_Exit (Inherited)
Widgets.Handle_Focus (Inherited)
Widgets.Handle_Key_Held (Inherited)
Widgets.Handle_Key_Press (Inherited)
Widgets.Handle_Key_Release (Inherited)
Widgets.Handle_Mouse_Held (Inherited)
Widgets.Handle_Mouse_Move (Inherited)
Widgets.Handle_Mouse_Press (Inherited)
Widgets.Handle_Mouse_Release (Inherited)
Widgets.Handle_Mouse_Scroll (Inherited)
Widgets.Handle_Resize (Inherited)
Widgets.Pack (Inherited)
Widgets.Set_Color (Inherited)
Widgets.Set_Dirty (Inherited)
Widgets.Set_Enabled (Inherited)
Widgets.Set_Focused (Inherited)
Widgets.Set_Parent (Inherited)
Widgets.Set_Visible (Inherited)
Widgets.Set_Zoom (Inherited)
Widgets.To_String (Inherited)
Widgets.Translate_To_Content (Inherited)
Widgets.Translate_To_Window (Inherited)

References:

widgets-progress_boards.ads:32:10 (declaration)
widgets-progress_boards.adb:16:47 (reference)
widgets-progress_boards.adb:25:46 (reference)
widgets-progress_boards.adb:37:40 (reference)
widgets-progress_boards.adb:50:43 (reference)
widgets-progress_boards.adb:83:37 (reference)
widgets-progress_boards.adb:93:46 (reference)
widgets-progress_boards.adb:110:43 (reference)
widgets-progress_boards.adb:184:44 (reference)
widgets-progress_boards.adb:198:43 (reference)
widgets-progress_boards.adb:212:46 (reference)
widgets-progress_boards.adb:221:37 (reference)
widgets-progress_boards.adb:229:50 (reference)
widgets-progress_boards.adb:238:39 (reference)
widgets-progress_boards.adb:249:43 (reference)
widgets-progress_boards.adb:260:43 (reference)
widgets-progress_boards.adb:271:40 (reference)
widgets-progress_boards.adb:282:44 (reference)
widgets-progress_boards.adb:293:40 (reference)
widgets-progress_boards.adb:304:43 (reference)
widgets-progress_boards.adb:315:44 (reference)
widgets-progress_boards.adb:326:41 (reference)
widgets-progress_boards.adb:337:42 (reference)
widgets-progress_boards.adb:348:40 (reference)
widgets-progress_boards.adb:359:45 (reference)
widgets-progress_boards.adb:370:35 (reference)
widgets-progress_boards.adb:392:35 (reference)
widgets-progress_boards.adb:434:37 (reference)
widgets-progress_boards.ads:33:41 (reference)
widgets-progress_boards.ads:42:47 (reference)
widgets-progress_boards.ads:47:46 (reference)
widgets-progress_boards.ads:52:37 (reference)
widgets-progress_boards.ads:54:50 (reference)
widgets-progress_boards.ads:57:39 (reference)
widgets-progress_boards.ads:59:43 (reference)
widgets-progress_boards.ads:61:43 (reference)
widgets-progress_boards.ads:63:40 (reference)
widgets-progress_boards.ads:65:44 (reference)
widgets-progress_boards.ads:67:40 (reference)
widgets-progress_boards.ads:69:43 (reference)
widgets-progress_boards.ads:71:44 (reference)
widgets-progress_boards.ads:73:41 (reference)
widgets-progress_boards.ads:75:42 (reference)
widgets-progress_boards.ads:77:40 (reference)
widgets-progress_boards.ads:79:45 (reference)
widgets-progress_boards.ads:81:35 (reference)
widgets-progress_boards.ads:85:37 (reference)
widgets-progress_boards.ads:118:10 (full declaration)
widgets-progress_boards.ads:145:43 (reference)
widgets-progress_boards.ads:152:37 (reference)
widgets-progress_boards.ads:154:46 (reference)
widgets-progress_boards.ads:156:43 (reference)
widgets-progress_boards.ads:158:44 (reference)
widgets-progress_boards.ads:160:43 (reference)
widgets-progress_boards.ads:162:46 (reference)
widgets-progress_boards.ads:164:35 (reference)

Types

A_PBoard_Action

type A_PBoard_Action is access all PBoard_Action'Class;

References:

widgets-progress_boards.ads:11:10 (declaration)
game_views-keen.adb:130:48 (reference)
widgets-progress_boards.adb:94:18 (reference)
widgets-progress_boards.adb:452:39 (reference)
widgets-progress_boards.adb:459:37 (reference)
widgets-progress_boards.adb:460:80 (reference)
widgets-progress_boards.ads:25:39 (reference)
widgets-progress_boards.ads:28:36 (reference)
widgets-progress_boards.ads:99:37 (reference)
widgets-progress_boards.ads:114:39 (reference)

PBoard_Listener (abstract)

type PBoard_Listener is limited interface and Action_Listener;
This is the interface to implement in order to listen to progress board actions. When an action occurs, the listener will be notified of the type of action performed and the progress board that performed the action.

A_PBoard_Listener

type A_PBoard_Listener is access all PBoard_Listener'Class;

References:

widgets-progress_boards.ads:22:10 (declaration)
widgets-progress_boards.adb:17:49 (reference)
widgets-progress_boards.adb:27:29 (reference)
widgets-progress_boards.adb:98:13 (reference)
widgets-progress_boards.adb:230:52 (reference)
widgets-progress_boards.adb:441:76 (reference)
widgets-progress_boards.adb:445:16 (reference)
widgets-progress_boards.ads:43:49 (reference)
widgets-progress_boards.ads:55:52 (reference)
widgets-progress_boards.ads:110:76 (reference)

A_PBoard_Handler

type A_PBoard_Handler is
        access procedure( action : A_PBoard_Action );

References:

widgets-progress_boards.ads:27:10 (declaration)
widgets-progress_boards.adb:26:48 (reference)
widgets-progress_boards.adb:441:50 (reference)
widgets-progress_boards.ads:48:48 (reference)
widgets-progress_boards.ads:106:23 (reference)
widgets-progress_boards.ads:110:50 (reference)

A_Progress_Board

type A_Progress_Board is access all Progress_Board'Class;

References:

widgets-progress_boards.ads:33:10 (declaration)
game_views-keen.adb:59:17 (reference)
game_views-keen.adb:161:13 (reference)
game_views-keen.adb:163:13 (reference)
game_views-keen.adb:166:13 (reference)
game_views-keen.adb:169:13 (reference)
game_views-keen.adb:171:13 (reference)
game_views-keen.adb:399:25 (reference)
widgets-progress_boards.adb:36:63 (reference)
widgets-progress_boards.adb:37:16 (reference)
widgets-progress_boards.ads:37:63 (reference)

Constants & Global variables

Opened (Actions.Action_Id)

Opened : constant Action_Id;

References:

widgets-progress_boards.ads:13:5 (declaration)
game_views-keen.adb:133:28 (reference)
widgets-progress_boards.adb:376:39 (reference)
widgets-progress_boards.ads:96:5 (full declaration)

Closed (Actions.Action_Id)

Closed : constant Action_Id;

References:

widgets-progress_boards.ads:14:5 (declaration)
game_views-keen.adb:135:31 (reference)
widgets-progress_boards.adb:411:39 (reference)
widgets-progress_boards.ads:97:5 (full declaration)

Subprograms & Entries

Handle_Action (abstract)

procedure Handle_Action
( this: access PBoard_Listener;
action: A_PBoard_Action )
is abstract;

References:

widgets-progress_boards.ads:24:15 (declaration)
widgets-progress_boards.adb:98:41 (dispatching call)

Called by:

Widgets.Progress_Boards.Dispatch_Action.Dispatch defined at widgets-progress_boards.adb:96:19

Create_Progress_Board

function Create_Progress_Board
( view: not null access Game_Views.Game_View'Class;
id: String;
libName: String )
return A_Progress_Board;

References:

widgets-progress_boards.ads:35:14 (declaration)
game_views-keen.adb:461:30 (reference)
widgets-progress_boards.adb:34:14 (body)
widgets-progress_boards.adb:45:9 (label)
widgets-progress_boards.ads:40:27 (reference)

Called by:

Game_Views.Keen.Populate_View defined at game_views-keen.ads:97:15

Calls:

Construct defined at widgets-progress_boards.ads:145:15
Widgets.Delete defined at widgets.ads:685:15

Add_Listener

procedure Add_Listener
( this: access Progress_Board;
listener: not null A_PBoard_Listener );

References:

widgets-progress_boards.ads:42:15 (declaration)
widgets-progress_boards.adb:16:15 (body)
widgets-progress_boards.adb:20:9 (label)
widgets-progress_boards.adb:29:14 (reference)

Calls:

Widgets.Add_Listener defined at widgets.ads:486:15

Add_Listener

procedure Add_Listener
( this: access Progress_Board;
handler: not null A_PBoard_Handler );

References:

widgets-progress_boards.ads:47:15 (declaration)
game_views-keen.adb:462:27 (dispatching call)
widgets-progress_boards.adb:25:15 (body)
widgets-progress_boards.adb:30:9 (label)

Called by:

Game_Views.Keen.Populate_View defined at game_views-keen.ads:97:15
Adds the handler procedure as a simple listener. The listener can't be removed and can be added multiple times.

Is_Open

function Is_Open
( this: access Progress_Board )
return Boolean;

References:

widgets-progress_boards.ads:52:14 (declaration)
widgets-progress_boards.adb:221:14 (body)
widgets-progress_boards.adb:224:9 (label)
widgets-progress_boards.adb:374:25 (reference)
widgets-progress_boards.adb:382:21 (reference)
widgets-progress_boards.adb:436:29 (reference)
Returns true if the board is not currently closed. It may be fully open or sliding in either direction.

Remove_Listener

procedure Remove_Listener
( this: access Progress_Board;
listener: not null A_PBoard_Listener );

References:

widgets-progress_boards.ads:54:15 (declaration)
widgets-progress_boards.adb:229:15 (body)
widgets-progress_boards.adb:233:9 (label)

Calls:

Widgets.Remove_Listener defined at widgets.ads:646:15

Set_Ammo

procedure Set_Ammo
( this: access Progress_Board;
ammo: Natural );

References:

widgets-progress_boards.ads:57:15 (declaration)
game_views-keen.adb:166:66 (dispatching call)
widgets-progress_boards.adb:238:15 (body)
widgets-progress_boards.adb:244:9 (label)

Called by:

Game_Views.Keen.Handle defined at game_views-keen.ads:44:15

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Ancients

procedure Set_Ancients
( this: access Progress_Board;
ancients: Natural );

References:

widgets-progress_boards.ads:59:15 (declaration)
widgets-progress_boards.adb:249:15 (body)
widgets-progress_boards.adb:255:9 (label)

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Blue_Key

procedure Set_Blue_Key
( this: access Progress_Board;
blueKey: Boolean );

References:

widgets-progress_boards.ads:61:15 (declaration)
widgets-progress_boards.adb:260:15 (body)
widgets-progress_boards.adb:266:9 (label)

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Drops

procedure Set_Drops
( this: access Progress_Board;
drops: Natural );

References:

widgets-progress_boards.ads:63:15 (declaration)
game_views-keen.adb:163:66 (dispatching call)
widgets-progress_boards.adb:271:15 (body)
widgets-progress_boards.adb:277:9 (label)

Called by:

Game_Views.Keen.Handle defined at game_views-keen.ads:44:15

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Green_Key

procedure Set_Green_Key
( this: access Progress_Board;
greenKey: Boolean );

References:

widgets-progress_boards.ads:65:15 (declaration)
widgets-progress_boards.adb:282:15 (body)
widgets-progress_boards.adb:288:9 (label)

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Lives

procedure Set_Lives
( this: access Progress_Board;
lives: Natural );

References:

widgets-progress_boards.ads:67:15 (declaration)
game_views-keen.adb:169:66 (dispatching call)
widgets-progress_boards.adb:293:15 (body)
widgets-progress_boards.adb:299:9 (label)

Called by:

Game_Views.Keen.Handle defined at game_views-keen.ads:44:15

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Location

procedure Set_Location
( this: access Progress_Board;
location: String );

References:

widgets-progress_boards.ads:69:15 (declaration)
widgets-progress_boards.adb:304:15 (body)
widgets-progress_boards.adb:310:9 (label)

Calls:

To_String defined at a-strunb.ads:65:13
To_Unbounded_String defined at a-strunb.ads:59:13
Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Next_Life

procedure Set_Next_Life
( this: access Progress_Board;
nextLife: Natural );

References:

widgets-progress_boards.ads:71:15 (declaration)
game_views-keen.adb:171:66 (dispatching call)
widgets-progress_boards.adb:315:15 (body)
widgets-progress_boards.adb:321:9 (label)

Called by:

Game_Views.Keen.Handle defined at game_views-keen.ads:44:15

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Points

procedure Set_Points
( this: access Progress_Board;
points: Natural );

References:

widgets-progress_boards.ads:73:15 (declaration)
game_views-keen.adb:161:66 (dispatching call)
widgets-progress_boards.adb:326:15 (body)
widgets-progress_boards.adb:332:9 (label)

Called by:

Game_Views.Keen.Handle defined at game_views-keen.ads:44:15

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Red_Key

procedure Set_Red_Key
( this: access Progress_Board;
redKey: Boolean );

References:

widgets-progress_boards.ads:75:15 (declaration)
widgets-progress_boards.adb:337:15 (body)
widgets-progress_boards.adb:343:9 (label)

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Scuba

procedure Set_Scuba
( this: access Progress_Board;
scuba: Boolean );

References:

widgets-progress_boards.ads:77:15 (declaration)
widgets-progress_boards.adb:348:15 (body)
widgets-progress_boards.adb:354:9 (label)

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Set_Yellow_Key

procedure Set_Yellow_Key
( this: access Progress_Board;
yellowKey: Boolean );

References:

widgets-progress_boards.ads:79:15 (declaration)
widgets-progress_boards.adb:359:15 (body)
widgets-progress_boards.adb:365:9 (label)

Calls:

Widgets.Set_Dirty defined at widgets.ads:662:15

Show

procedure Show
( this: access Progress_Board;
enabled: Boolean );

References:

widgets-progress_boards.ads:81:15 (declaration)
widgets-progress_boards.adb:370:15 (body)
widgets-progress_boards.adb:387:9 (label)
widgets-progress_boards.adb:436:14 (reference)

Toggle

procedure Toggle
( this: access Progress_Board );

References:

widgets-progress_boards.ads:85:15 (declaration)
game_views-keen.adb:59:70 (dispatching call)
widgets-progress_boards.adb:434:15 (body)
widgets-progress_boards.adb:437:9 (label)

Called by:

Game_Views.Keen.Scene_Key_Handler defined at game_views-keen.adb:49:15
Toggles the open/closed state of the progress board. Calling this is equivalent to this.Show( not this.Is_Open ).