FireSolution for Delphi.FMX

Class TFireDockMainForm

Description
Hierarchy
Fields
Methods
Properties

Unit

FireDockingMainForm

Declaration

type TFireDockMainForm = class(TFireForm)

Description

The main form of an application that has a mechanism of dock panels.

It has a customized dock manager and all the necessary functions for adding dockable panels and bars. It has a references to the MenuBar and to StatusBar.

See also
TFireDockPanelManager
Class TFireDockPanelManager is used to add Microsoft-like dock panels to the certain TControl.

Hierarchy

Overview

Methods

Protected procedure Init;
Public constructor Create(AOwner: TComponent); reintroduce;
Public destructor Destroy; override;
Public function GetMenuBar: TControl;
Public procedure SetMenuBar(MenuBar: TControl);
Public function GetStatusBar: TControl;
Public procedure SetStatusBar(StatusBar: TControl);
Public function GetCentralControl: TControl;
Public procedure SetCentralControl(Control: TControl);
Public function DockPanelManager: TFireDockPanelManager;
Public function AddDockWindow(Panel: TFireDockPanelBase; const ScreenRect: TRect): TFireDockWindow;
Public function AddDockPanel(const Title: String; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil): TFireDockControlPanel; overload;
Public function AddDockPanel(const Title: String; const DefaultSize: TSizeF; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil): TFireDockControlPanel; overload;
Public procedure InsertDockPanel(Panel: TFireDockControlPanel; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil); overload;
Public procedure InsertDockPanel(Panel: TFireDockControlPanel; const DefaultSize: TSizeF; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil); overload;
Public procedure RemoveDockPanel(Panel: TFireDockControlPanel);
Public procedure ClearDockPanels;
Public procedure SaveToStream(Stream: TStream);
Public function LoadFromStream(Stream: TStream): Boolean;

Description

Methods

Protected procedure Init;
 
Public constructor Create(AOwner: TComponent); reintroduce;

Constructor of the class TFireDockMainForm. The AOwner parameter by default is nil.

Public destructor Destroy; override;
 
Public function GetMenuBar: TControl;

Returns the menu bar for the main form. This function creates and returns an empty menu bar if the menu bar does not exist.

Public procedure SetMenuBar(MenuBar: TControl);

Sets the menu bar for the main form to menuBar. Note: TFireDockMainForm takes ownership of the menuBar pointer and deletes it at the appropriate time.

Public function GetStatusBar: TControl;

Returns the status bar for the main form. This function creates and returns an empty status bar StatusBar if the status bar does not exist.

Public procedure SetStatusBar(StatusBar: TControl);

Sets the status bar for the main form to statusbar. Setting the status bar to nil will remove it from the main form. Note: TFireDockMainForm takes ownership of the statusbar pointer and deletes it at the appropriate time.

Public function GetCentralControl: TControl;

Returns the central control for the main form. This function returns zero if the central control has not been set.

Public procedure SetCentralControl(Control: TControl);

Sets the given widget to be the main form's central control. Note: TFireDockMainForm takes ownership of the widget pointer and deletes it at the appropriate time.

Public function DockPanelManager: TFireDockPanelManager;

Returns TFireDockPanelManager that manages the main form.

Public function AddDockWindow(Panel: TFireDockPanelBase; const ScreenRect: TRect): TFireDockWindow;

Forwards the call to TFireDockPanelManager.AddDockWindow() that manages the main form.

See also
TFireDockPanelManager.AddDockWindow
Public function AddDockPanel(const Title: String; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil): TFireDockControlPanel; overload;

Forwards the call to TFireDockPanelManager that manages the main form.

See also
TFireDockPanelManager.AddDockPanel
Public function AddDockPanel(const Title: String; const DefaultSize: TSizeF; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil): TFireDockControlPanel; overload;

Forwards the call to TFireDockPanelManager that manages the main form.

See also
TFireDockPanelManager.AddDockPanel
Public procedure InsertDockPanel(Panel: TFireDockControlPanel; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil); overload;

Forwards the call to TFireDockPanelManager that manages the main form.

See also
TFireDockPanelManager.InsertDockPanel
Public procedure InsertDockPanel(Panel: TFireDockControlPanel; const DefaultSize: TSizeF; Area: TFireDockPanelArea; TargetPanel: TFireDockPanelBase = nil); overload;

Forwards the call to TFireDockPanelManager that manages the main form.

See also
TFireDockPanelManager.InsertDockPanel
Public procedure RemoveDockPanel(Panel: TFireDockControlPanel);

Forwards the call to TFireDockPanelManager that manages the main form.

See also
TFireDockPanelManager.RemoveDockPanel
Public procedure ClearDockPanels;

Forwards the call to TFireDockPanelManager that manages the main form.

See also
TFireDockPanelManager.ClearDockPanels
Public procedure SaveToStream(Stream: TStream);

Saves the dock panels and bars state to the Stream.

Public function LoadFromStream(Stream: TStream): Boolean;

Restores the dock panels and bars state from the Stream.

© 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.