Class TPGCaptionBarComponent (unit PGDsgFrm)

Inherits from

TComponent

Constructors


constructor Create(AOwner:TComponent);

TPGCaptionBarComponent


Functions

function CurrentSizeIs(const AWidth: Integer; const AHeight: Integer): Boolean;


destructor Destroy;

Finally, initialize the size of this component as it's created on } { the caption bar.

procedure GetMinSize(var MinWidth, MinHeight: Integer);


procedure Refresh;


procedure RefreshAfterRedrawing;


procedure AfterLoaded;

Make the width arbitrarily one greater than the height.

procedure CapturedNotOverMouseTarget(XPos: Integer; YPos: Integer);


procedure CapturedOverMouseTarget(XPos: Integer; YPos: Integer);

JJJ* Change this back to Refresh

procedure Click;


procedure DblClick;


function DoResizing: Boolean;


function FindCapBarVCLByClass(var Source: TPGCaptionBarComponent; AClassType: TComponentClass): Boolean;

Trys to find any other component of the same class as specified by 'AClassType'.

procedure FinishClickSequence(FinishedOverMouseTarget: Boolean);


procedure FireEvent(AnEvent: TNotifyEvent);

Fire's an event if it is defined.

function GetBoundsRect: TRect;

Returns the bounding rectangle of the component, in client coordinates } { relative to the origin of the non client area.

function GetClientRect: TRect;

Returns the bounding rectangle of the component, in client coordinates } { relative to the origin of the non client area.

function GetDown: Boolean;


function GetEnabled: Boolean;

Returns whether or not our size was updated.

function GetHeight: Integer;


function GetIndex: Byte;

Exchange the current index with whichever component } { has the target index.

function GetState: TPGGlyphState;


function GetVisible: Boolean;


function GetWidth: Integer;


function HasParent: Boolean;


procedure InitializePropertiesAtCreation;


procedure InitializeSizeAtCreation;


function IsDesignTime: Boolean;


function IsEnabled: Boolean;


function IsRuntime: Boolean;


function IsTransparent: Boolean;


function LoadingFromStream: Boolean;


procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);


procedure MouseMove(Shift: TShiftState; X, Y: Integer);

JJJ* Change this back to Refresh

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);


procedure Paint(ARect: TRect);


procedure ReadState(Reader: TReader);

Set the new height.

procedure RefreshOnMouseInput;


procedure SetAlign(Value: TLeftRight);

Property management

procedure SetAllowDragging(Value: Boolean);

Put the component in the up state, if it isn't already.

procedure SetAutosize(Value: Boolean);


procedure SetButtonType(Value: TPGCaptionBarComponentButtonType);


procedure SetCenter(Value: Boolean);


procedure SetDown(Value: Boolean);


procedure SetEnabled(Value: Boolean);


procedure SetHeight(Value: Integer);

Remove this component from the list of caption bar components.

procedure SetHorzGap(Value: Integer);


procedure SetIndex(Value: Byte);

Components are drawn in order of index, then by alignment.

procedure SetPopupMenu(Value: TPopupMenu);


procedure SetState(Value: TPGGlyphState );


procedure SetVertGap(Value: Integer);


procedure SetVisible(Value: Boolean);


procedure SetWidth(Value: Integer);


function ShouldAutosize: Boolean;


function ShouldDoDefaultAction: Boolean;


function ShouldShowPopup: Boolean;


function ShouldUpdateSize: Boolean;


function ShouldWaitForDoubleClick: Boolean;


procedure ShowPopup;


function SizeToAtLeastMinSize: Boolean;

Sizing functions

Updates the size of the component to be at least it's minimum allowed size.


function SizeToMinSize: Boolean;

Updates the size of the component to be at least it's minimum allowed size.

function UpdateSize: Boolean;

Returns true if the size was changed, false otherwise.

function WindowRect: TRect;

Returns the bounding rectangle of the component, in screen coordinates.

function yPos: Integer;


Properties

property Align : TLeftRight


property Height : Integer


property HorzGap : Integer


property Index : Byte


property VertGap : Integer


property Visible : Boolean


property Width : Integer


property BoundsRect : TRect


property ClientRect : TRect


property AllowDragging : Boolean


property Autosize : Boolean


property ButtonType : TPGCaptionBarComponentButtonType


property Canvas : TCanvas


property CaptionBar : TPGCaptionBar


property Center : Boolean


property Down : Boolean


property Enabled : Boolean


property PopupMenu : TPopupMenu


property State : TPGGlyphState


Events

event OnClick : TNotifyEvent


event OnDblClick : TNotifyEvent


event OnMouseDown : TMouseEvent


event OnMouseMove : TMouseMoveEvent


event OnMouseUp : TMouseEvent


Variables

FAlign : TLeftRight;


FAllowDragging : Boolean;


FAutosize : Boolean;


FButtonType : TPGCaptionBarComponentButtonType;


FCanvas : TCanvas;


FCaptionBar : TPGCaptionBar;


FCenter : Boolean;


FHeight : Integer;


FHorzGap : Integer;


FIndex : Byte;


FOnClick : TNotifyEvent;


FOnDblClick : TNotifyEvent;


FOnMouseDown : TMouseEvent;


FOnMouseMove : TMouseMoveEvent;


FOnMouseUp : TMouseEvent;


Form : TForm;


FPopupMenu : TPopupMenu;


FState : TPGGlyphState;


FVertGap : Integer;


FVisible : Boolean;


FWidth : Integer;


NeedsPainting : Boolean;


xPos : Integer;



Constructors


constructor Create(AOwner:TComponent);

TPGCaptionBarComponent


Functions


function CurrentSizeIs(const AWidth: Integer; const AHeight: Integer): Boolean;


destructor Destroy;

Finally, initialize the size of this component as it's created on } { the caption bar.


procedure GetMinSize(var MinWidth, MinHeight: Integer);


procedure Refresh;


procedure RefreshAfterRedrawing;


procedure AfterLoaded;

Make the width arbitrarily one greater than the height. This } { is similar to the default size of caption bar buttons, as made } { by Windows.


procedure CapturedNotOverMouseTarget(XPos: Integer; YPos: Integer);


procedure CapturedOverMouseTarget(XPos: Integer; YPos: Integer);

JJJ* Change this back to Refresh


procedure Click;


procedure DblClick;


function DoResizing: Boolean;


function FindCapBarVCLByClass(var Source: TPGCaptionBarComponent; AClassType: TComponentClass): Boolean;

Trys to find any other component of the same class as specified by 'AClassType'. } { If it finds it, it puts the component in 'Source' and returns true, otherwise it } { leaves 'Source' unmodifed, and returns false.


procedure FinishClickSequence(FinishedOverMouseTarget: Boolean);


procedure FireEvent(AnEvent: TNotifyEvent);

Fire's an event if it is defined.


function GetBoundsRect: TRect;

Returns the bounding rectangle of the component, in client coordinates } { relative to the origin of the non client area.


function GetClientRect: TRect;

Returns the bounding rectangle of the component, in client coordinates } { relative to the origin of the non client area.


function GetDown: Boolean;


function GetEnabled: Boolean;

Returns whether or not our size was updated.


function GetHeight: Integer;


function GetIndex: Byte;

Exchange the current index with whichever component } { has the target index.


function GetState: TPGGlyphState;


function GetVisible: Boolean;


function GetWidth: Integer;


function HasParent: Boolean;


procedure InitializePropertiesAtCreation;


procedure InitializeSizeAtCreation;


function IsDesignTime: Boolean;


function IsEnabled: Boolean;


function IsRuntime: Boolean;


function IsTransparent: Boolean;


function LoadingFromStream: Boolean;


procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);


procedure MouseMove(Shift: TShiftState; X, Y: Integer);

JJJ* Change this back to Refresh


procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Integer);


procedure Paint(ARect: TRect);


procedure ReadState(Reader: TReader);

Set the new height.


procedure RefreshOnMouseInput;


procedure SetAlign(Value: TLeftRight);

Property management


procedure SetAllowDragging(Value: Boolean);

Put the component in the up state, if it isn't already.


procedure SetAutosize(Value: Boolean);


procedure SetButtonType(Value: TPGCaptionBarComponentButtonType);


procedure SetCenter(Value: Boolean);


procedure SetDown(Value: Boolean);


procedure SetEnabled(Value: Boolean);


procedure SetHeight(Value: Integer);

Remove this component from the list of caption bar components.


procedure SetHorzGap(Value: Integer);


procedure SetIndex(Value: Byte);

Components are drawn in order of index, then by alignment. This } { procedure allows components to be rearranged by changing their } { position in the caption bar component list.


procedure SetPopupMenu(Value: TPopupMenu);


procedure SetState(Value: TPGGlyphState );


procedure SetVertGap(Value: Integer);


procedure SetVisible(Value: Boolean);


procedure SetWidth(Value: Integer);


function ShouldAutosize: Boolean;


function ShouldDoDefaultAction: Boolean;


function ShouldShowPopup: Boolean;


function ShouldUpdateSize: Boolean;


function ShouldWaitForDoubleClick: Boolean;


procedure ShowPopup;


function SizeToAtLeastMinSize: Boolean;

Sizing functions

Updates the size of the component to be at least it's minimum allowed size. } { Returns true if the size was changed, false otherwise.


function SizeToMinSize: Boolean;

Updates the size of the component to be at least it's minimum allowed size. } { Returns true if the size was changed, false otherwise.


function UpdateSize: Boolean;

Returns true if the size was changed, false otherwise.


function WindowRect: TRect;

Returns the bounding rectangle of the component, in screen coordinates.


function yPos: Integer;


Properties


property Align : TLeftRight


property Height : Integer


property HorzGap : Integer


property Index : Byte


property VertGap : Integer


property Visible : Boolean


property Width : Integer


property BoundsRect : TRect


property ClientRect : TRect


property AllowDragging : Boolean


property Autosize : Boolean


property ButtonType : TPGCaptionBarComponentButtonType


property Canvas : TCanvas


property CaptionBar : TPGCaptionBar


property Center : Boolean


property Down : Boolean


property Enabled : Boolean


property PopupMenu : TPopupMenu


property State : TPGGlyphState


Events


event OnClick : TNotifyEvent


event OnDblClick : TNotifyEvent


event OnMouseDown : TMouseEvent


event OnMouseMove : TMouseMoveEvent


event OnMouseUp : TMouseEvent


Variables


FAlign : TLeftRight;


FAllowDragging : Boolean;


FAutosize : Boolean;


FButtonType : TPGCaptionBarComponentButtonType;


FCanvas : TCanvas;


FCaptionBar : TPGCaptionBar;


FCenter : Boolean;


FHeight : Integer;


FHorzGap : Integer;


FIndex : Byte;


FOnClick : TNotifyEvent;


FOnDblClick : TNotifyEvent;


FOnMouseDown : TMouseEvent;


FOnMouseMove : TMouseMoveEvent;


FOnMouseUp : TMouseEvent;


Form : TForm;


FPopupMenu : TPopupMenu;


FState : TPGGlyphState;


FVertGap : Integer;


FVisible : Boolean;


FWidth : Integer;


NeedsPainting : Boolean;


xPos : Integer;