FireSolution for Delphi.FMX

Class TFireDockControlPanel

Description
Hierarchy
Fields
Methods
Properties

Unit

FireDockingControlPanel

Declaration

type TFireDockControlPanel = class(TFireDockPanelBase)

Description

Implements the Panel for docking that contains TControl.

Control panel is used to add custom TControl to the docked interface. The panel is created through the docking manager. The panel is a leaf in the docking panels tree and cannot contain other panels.

See also
TFireDockLayoutPanel
Implements the layout Panel.

Hierarchy

Overview

Methods

Protected procedure DoPaint; override;
Protected procedure Paint; override;
Protected procedure DoEnter; override;
Protected procedure DoExit; override;
Protected procedure UpdateActions;
Protected procedure CheckActions;
Protected procedure Init;
Public constructor Create(Manager: TFireDockPanelManagerBase; const Title: String = ''); reintroduce;
Public destructor Destroy; override;
Public procedure ParentLayoutChanged; override;
Public procedure SetGeometry(const Rect: TRectF); override;
Public function Clone(PanelMap: TFireDockPanelMap): TFireDockPanelBase; override;
Public procedure SetParentPanel(PanelBase: TFireDockPanelBase); override;
Public procedure GetMinMaxData(var MinMaxSize: TFireDockMinMaxSize); override;
Public function GetInfo: PFireDockControlPanelInfo;
Public function GetTitleBar: TFireDockTitleBar;
Public function GetTitle: String;
Public procedure SetTitle(const Title: String);
Public function GetToolTip: String;
Public procedure SetToolTip(const ToolTip: String);
Public function GetContent: TControl;
Public procedure SetContent(Content: TControl);
Public function GetIcon: TBitmap;
Public procedure SetIcon(const Icon: TBitmap);
Public function GetMenuButton: TPopupMenu;
Public procedure SetMenuButton(Menu: TPopupMenu);
Public procedure SetFeatures(Features: TFireDockPanelFeatures);
Public function GetFeatures: TFireDockPanelFeatures;
Public function IsValid: Boolean;
Public function IsClosed: Boolean;
Public procedure ShowPanel;
Public procedure ClosePanel;
Public function IsAutoHide: Boolean; override;
Public procedure SetAutoHide(AutoHide: Boolean);
Public function IsActive: Boolean;
Public procedure Activate;
Public procedure Deactivate;
Public function IsFloat: Boolean;
Public procedure SetFloat(_Float: Boolean);
Public function GetAllowedAreas: TFireDockPanelAreas; virtual;
Public procedure SetAllowedAreas(Areas: TFireDockPanelAreas);
Public function IsAreaAllowed(Area: TFireDockPanelArea): Boolean;
Public function GetVisibleAction: TCustomAction;

Properties

Public property Title: String read GetTitle write SetTitle;
Public property ToolTip: String read GetToolTip write SetToolTip;
Public property Content: TControl read GetContent write SetContent;
Public property Icon: TBitmap read GetIcon write SetIcon;
Public property AutoHideAction: TCustomAction read FAutoHideAction;
Public property FloatAction: TCustomAction read FFloatAction;
Public property DockAction: TCustomAction read FDockAction;
Public property HideAction: TCustomAction read FHideAction;
Public property VisibleAction: TCustomAction read FVisibleAction;

Description

Methods

Protected procedure DoPaint; override;
 
Protected procedure Paint; override;
 
Protected procedure DoEnter; override;
 
Protected procedure DoExit; override;
 
Protected procedure UpdateActions;
 
Protected procedure CheckActions;
 
Protected procedure Init;
 
Public constructor Create(Manager: TFireDockPanelManagerBase; const Title: String = ''); reintroduce;
 
Public destructor Destroy; override;
 
Public procedure ParentLayoutChanged; override;
 
Public procedure SetGeometry(const Rect: TRectF); override;
 
Public function Clone(PanelMap: TFireDockPanelMap): TFireDockPanelBase; override;
 
Public procedure SetParentPanel(PanelBase: TFireDockPanelBase); override;
 
Public procedure GetMinMaxData(var MinMaxSize: TFireDockMinMaxSize); override;
 
Public function GetInfo: PFireDockControlPanelInfo;
 
Public function GetTitleBar: TFireDockTitleBar;
 
Public function GetTitle: String;
 
Public procedure SetTitle(const Title: String);
 
Public function GetToolTip: String;
 
Public procedure SetToolTip(const ToolTip: String);
 
Public function GetContent: TControl;
 
Public procedure SetContent(Content: TControl);
 
Public function GetIcon: TBitmap;
 
Public procedure SetIcon(const Icon: TBitmap);
 
Public function GetMenuButton: TPopupMenu;
 
Public procedure SetMenuButton(Menu: TPopupMenu);
 
Public procedure SetFeatures(Features: TFireDockPanelFeatures);
 
Public function GetFeatures: TFireDockPanelFeatures;
 
Public function IsValid: Boolean;
 
Public function IsClosed: Boolean;
 
Public procedure ShowPanel;
 
Public procedure ClosePanel;
 
Public function IsAutoHide: Boolean; override;
 
Public procedure SetAutoHide(AutoHide: Boolean);
 
Public function IsActive: Boolean;

Returns True if the Panel is active, otherwise returns False.

Public procedure Activate;

Activates the Panel and move the focus to the first TControl on this Panel.

Public procedure Deactivate;

Deactivates the Panel and blurs the focus.

Public function IsFloat: Boolean;

Returns True if the Panel is float.

Public procedure SetFloat(_Float: Boolean);

Determines whether the Panel is floating or not. If the parameter _float is True the Panel should be floating. In floating mode, the Panel is placed on a separate top-level window.

Public function GetAllowedAreas: TFireDockPanelAreas; virtual;

Returns the bit mask of the flags in which areas the docking of this Panel is allowed.

Public procedure SetAllowedAreas(Areas: TFireDockPanelAreas);

Sets the bit mask of the flags in which areas the docking of this Panel is allowed.

Public function IsAreaAllowed(Area: TFireDockPanelArea): Boolean;

Returns True if the Panel can be docked to \a area otherwise returns False.

Public function GetVisibleAction: TCustomAction;

Returns TCustomAction that can be used to control this Panel visibility.

Properties

Public property Title: String read GetTitle write SetTitle;
 
Public property ToolTip: String read GetToolTip write SetToolTip;
 
Public property Content: TControl read GetContent write SetContent;
 
Public property Icon: TBitmap read GetIcon write SetIcon;
 
Public property AutoHideAction: TCustomAction read FAutoHideAction;
 
Public property FloatAction: TCustomAction read FFloatAction;
 
Public property DockAction: TCustomAction read FDockAction;
 
Public property HideAction: TCustomAction read FHideAction;
 
Public property VisibleAction: TCustomAction read FVisibleAction;
 

© 2009-2020 Developer Machines

Delphi and their respective logos are trademarks of Embarcadero Corporation in USA and/or other countries worldwide.

All other trademarks are property of their respective owners. Privacy Policy

Generated by PasDoc 0.15.0.