Unit CastleUIControls

DescriptionUsesClasses, Interfaces, Objects and RecordsFunctions and ProceduresTypesConstantsVariables

Description

User interface (2D) basic classes.

Uses

Overview

Classes, Interfaces, Objects and Records

Name Description
Object TTouch  
Class TTouchList  
Class TUIContainer Abstract user interface container.
Class TInputListener Base class for things that listen to user input: cameras and 2D controls.
Class TUIControl Basic user interface control class.
Class TUIRectangularControl TUIControl that has a position and takes some rectangular space on the container.
Class TUIControlList  
Class TGLContextEventList  

Functions and Procedures

function OnGLContextOpen: TGLContextEventList;
function OnGLContextClose: TGLContextEventList;

Types

TRenderStyle = (...);
TContainerEvent = procedure (Container: TUIContainer);
TContainerObjectEvent = procedure (Container: TUIContainer) of object;
TInputPressReleaseEvent = procedure (Container: TUIContainer; const Event: TInputPressRelease);
TInputMotionEvent = procedure (Container: TUIContainer; const Event: TInputMotion);
PTouch = ˆTTouch;
TPositionRelative = (...);
TUIControlPos = TUIRectangularControl deprecated;
TGLContextEvent = procedure;

Constants

DefaultDpi = 96;
DefaultTooltipDelay = 1000;
DefaultTooltipDistance = 10;
ds2D = rs2D deprecated;
ds3D = rs3D deprecated;
prLeft = prLow deprecated;
prRight = prHigh deprecated;
prBottom = prLow deprecated;
prTop = prHigh deprecated;
hpLeft = CastleRectangles.hpLeft ;
hpMiddle = CastleRectangles.hpMiddle;
hpRight = CastleRectangles.hpRight ;
vpBottom = CastleRectangles.vpBottom;
vpMiddle = CastleRectangles.vpMiddle;
vpTop = CastleRectangles.vpTop ;

Description

Functions and Procedures

function OnGLContextOpen: TGLContextEventList;

Global callbacks called when OpenGL context (like Lazarus TCastleControl or TCastleWindow) is open/closed. Useful for things that want to be notified about OpenGL context existence, but cannot refer to a particular instance of TCastleControl or TCastleWindow.

Note that we may have many OpenGL contexts (TCastleWindow or TCastleControl) open simultaneously. They all share OpenGL resources. OnGLContextOpen is called when first OpenGL context is open, that is: no previous context was open. OnGLContextClose is called when last OpenGL context is closed, that is: no more contexts remain open. Note that this implies that they may be called many times: e.g. if you open one window, then close it, then open another window then close it.

Callbacks on OnGLContextOpen are called from first to last. Callbacks on OnGLContextClose are called in reverse order, so OnGLContextClose[0] is called last.

function OnGLContextClose: TGLContextEventList;
 

Types

TRenderStyle = (...);

Determines the order in which TUIControl.Render is called. All 3D controls are always under all 2D controls. See TUIControl.Render, TUIControl.RenderStyle.

Values
  • rs2D:  
  • rs3D:  
TContainerEvent = procedure (Container: TUIContainer);
 
TContainerObjectEvent = procedure (Container: TUIContainer) of object;
 
TInputPressReleaseEvent = procedure (Container: TUIContainer; const Event: TInputPressRelease);
 
TInputMotionEvent = procedure (Container: TUIContainer; const Event: TInputMotion);
 
PTouch = ˆTTouch;
 
TPositionRelative = (...);

Warning: this symbol is deprecated.

Position for relative layout of one control in respect to another. Deprecated, rather use cleaner THorizontalPosition and TVerticalPosition.

Values
  • prLow:  
  • prMiddle:  
  • prHigh:  
TUIControlPos = TUIRectangularControl deprecated;

Warning: this symbol is deprecated.

 
TGLContextEvent = procedure;
 

Constants

DefaultDpi = 96;

Default value for container's Dpi, as is usually set on desktops.

DefaultTooltipDelay = 1000;
 
DefaultTooltipDistance = 10;
 
ds2D = rs2D deprecated;

Warning: this symbol is deprecated.

Deprecated name for rs2D.

ds3D = rs3D deprecated;

Warning: this symbol is deprecated.

Deprecated name for rs3D.

prLeft = prLow deprecated;

Warning: this symbol is deprecated.

 
prRight = prHigh deprecated;

Warning: this symbol is deprecated.

 
prBottom = prLow deprecated;

Warning: this symbol is deprecated.

 
prTop = prHigh deprecated;

Warning: this symbol is deprecated.

 
hpLeft = CastleRectangles.hpLeft ;
 
hpMiddle = CastleRectangles.hpMiddle;
 
hpRight = CastleRectangles.hpRight ;
 
vpBottom = CastleRectangles.vpBottom;
 
vpMiddle = CastleRectangles.vpMiddle;
 
vpTop = CastleRectangles.vpTop ;
 

Generated by PasDoc 0.14.0.