Interface IUIContainer

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type IUIContainer = interface(IInterface)

Description

Basic user interface container. This may be a window (like TCastleWindowCustom) or some Lazarus control (like TCastleControlCustom component).

Attributes
GUID['{0F0BA87D-95C3-4520-B9F9-CDF30015FDB3}']

Hierarchy

  • IInterface
  • IUIContainer

Overview

Methods

Public procedure SetMousePosition(const NewMouseX, NewMouseY: Integer);
Public function GetMouseX: Integer;
Public function GetMouseY: Integer;
Public function GetWidth: Integer;
Public function GetHeight: Integer;
Public function GetMousePressed: TMouseButtons;
Public function GetPressed: TKeysPressed;
Public function GetTooltipX: Integer;
Public function GetTooltipY: Integer;
Public procedure UpdateFocusAndMouseCursor;

Properties

Public property MouseX: Integer read GetMouseX;
Public property MouseY: Integer read GetMouseY;
Public property Width: Integer read GetWidth;
Public property Height: Integer read GetHeight;
Public property MousePressed: TMouseButtons read GetMousePressed;
Public property Pressed: TKeysPressed read GetPressed;
Public property TooltipX: Integer read GetTooltipX;
Public property TooltipY: Integer read GetTooltipY;

Description

Methods

Public procedure SetMousePosition(const NewMouseX, NewMouseY: Integer);
 
Public function GetMouseX: Integer;
 
Public function GetMouseY: Integer;
 
Public function GetWidth: Integer;
 
Public function GetHeight: Integer;
 
Public function GetMousePressed: TMouseButtons;
 
Public function GetPressed: TKeysPressed;
 
Public function GetTooltipX: Integer;
 
Public function GetTooltipY: Integer;
 
Public procedure UpdateFocusAndMouseCursor;

Called by controls within this container when something could change the container focused control (or it's cursor). In practice, called when TUIControl.Cursor or TUIControl.PositionInside results change. This is called by a IUIContainer interface, that's why it can remain as private method of actual container class.

This recalculates the focused control and the final cursor of the container, looking at Container's UseControls, testing PositionInside with current mouse position, and looking at Cursor property of the focused control.

When UseControls change, or when you add / remove some control from the Controls list, or when you move mouse (focused changes) this will also be automatically called (since focused control or final container cursor may also change then).

Properties

Public property MouseX: Integer read GetMouseX;
 
Public property MouseY: Integer read GetMouseY;
 
Public property Width: Integer read GetWidth;
 
Public property Height: Integer read GetHeight;
 
Public property MousePressed: TMouseButtons read GetMousePressed;

Mouse buttons currently pressed.

Public property Pressed: TKeysPressed read GetPressed;

Keys currently pressed.

Public property TooltipX: Integer read GetTooltipX;
 
Public property TooltipY: Integer read GetTooltipY;
 

Generated by PasDoc 0.13.0 on 2013-08-17 21:27:14