Index

Package: Progress_Boards

Description

package Widgets.Progress_Boards is
Copyright (c) 2012 Kevin Wellwood All rights reserved. This source code is distributed under the Modified BSD License. For terms and conditions, see license.txt.

Classes

PBoard_Action

type PBoard_Action is new Action with private;

Ancestors:

Primitive operations:

Actions.Construct (Inherited)
Objects.Adjust (Inherited)
Objects.Construct (Inherited)
Objects.Delete (Inherited)
Objects.Object_Read (Inherited)
Objects.Object_Write (Inherited)
Objects.To_String (Inherited)

Progress_Board

type Progress_Board is new Widget and Animated with private;

Ancestors:

Primitive operations:

Add_Listener
Construct
Delete (overriding Widgets.Delete)
Dispatch_Action
Draw_Content
Objects.Construct (Inherited)
Processes.Get_Process_Name (Inherited)
Processes.Tick (Inherited)
Remove_Listener
Tick
Widgets.Activate_Popup (Inherited)
Widgets.Bring_To_Front (Inherited)
Widgets.Construct (Inherited)
Widgets.Draw (Inherited)
Widgets.Draw_Content (Inherited)
Widgets.Find_Widget_At (Inherited)
Widgets.Get_Color (Inherited)
Widgets.Get_Min_Height (Inherited)
Widgets.Get_Min_Width (Inherited)
Widgets.Get_Process_Name (Inherited)
Widgets.Get_View (Inherited)
Widgets.Get_Window (Inherited)
Widgets.Handle_Rooted (Inherited)
Widgets.Handle_Shown (Inherited)
Widgets.Is_Rooted (Inherited)
Widgets.Is_Showing (Inherited)
Widgets.On_Blur (Inherited)
Widgets.On_Click (Inherited)
Widgets.On_Descendant_Shown (Inherited)
Widgets.On_Disabled (Inherited)
Widgets.On_Enabled (Inherited)
Widgets.On_Enter (Inherited)
Widgets.On_Exit (Inherited)
Widgets.On_Focus (Inherited)
Widgets.On_Key_Press (Inherited)
Widgets.On_Key_Release (Inherited)
Widgets.On_Key_Typed (Inherited)
Widgets.On_Mouse_Held (Inherited)
Widgets.On_Mouse_Move (Inherited)
Widgets.On_Mouse_Press (Inherited)
Widgets.On_Mouse_Release (Inherited)
Widgets.On_Mouse_Scroll (Inherited)
Widgets.On_Resize (Inherited)
Widgets.On_Rooted (Inherited)
Widgets.On_Shown (Inherited)
Widgets.Pack (Inherited)
Widgets.Set_Border (Inherited)
Widgets.Set_Color (Inherited)
Widgets.Set_Parent (Inherited)
Widgets.Set_Zoom (Inherited)
Widgets.To_String (Inherited)
Widgets.Translate_To_Content (Inherited)
Widgets.Translate_To_Window (Inherited)

Types

A_PBoard_Action

type A_PBoard_Action is access all PBoard_Action'Class;

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;

A_Progress_Board

type A_Progress_Board is access all Progress_Board'Class;

Constants & Global variables

Subprograms & Entries

Handle_Action (abstract)

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

Create_Progress_Board

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

Add_Listener

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

Is_Open

function Is_Open
( this: access Progress_Board ) return Boolean;
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 );

Set_Ammo

procedure Set_Ammo
( this: not null access Progress_Board'Class;
ammo: Natural );

Set_Ancients

procedure Set_Ancients
( this: not null access Progress_Board'Class;
ancients: Natural );

Set_Blue_Key

procedure Set_Blue_Key
( this: not null access Progress_Board'Class;
blueKey: Boolean );

Set_Drops

procedure Set_Drops
( this: not null access Progress_Board'Class;
drops: Natural );

Set_Green_Key

procedure Set_Green_Key
( this: not null access Progress_Board'Class;
greenKey: Boolean );

Set_Lives

procedure Set_Lives
( this: not null access Progress_Board'Class;
lives: Natural );

Set_Location

procedure Set_Location
( this: not null access Progress_Board'Class;
location: String );

Set_Next_Life

procedure Set_Next_Life
( this: not null access Progress_Board'Class;
nextLife: Natural );

Set_Points

procedure Set_Points
( this: not null access Progress_Board'Class;
points: Natural );

Set_Red_Key

procedure Set_Red_Key
( this: not null access Progress_Board'Class;
redKey: Boolean );

Set_Scuba

procedure Set_Scuba
( this: not null access Progress_Board'Class;
scuba: Boolean );

Set_Yellow_Key

procedure Set_Yellow_Key
( this: not null access Progress_Board'Class;
yellowKey: Boolean );

Show

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

Toggle

procedure Toggle
( this: access Progress_Board );
Toggles the open/closed state of the progress board. Calling this is equivalent to this.Show( not this.Is_Open ).