MSEgui documentation

Class tdockcontroller

Description
Hierarchy
Fields
Methods
Properties

Unit

msedock

Declaration

type tdockcontroller = class(tdragcontroller)

Description

No description available, ancestor tdragcontroller description follows
No description available, ancestor tcustomdragcontroller description follows
No description available, ancestor tlinkedpersistent description follows
No description available, ancestor tnullinterfacedpersistent description follows
No description available, ancestor tvirtualpersistent description follows

Hierarchy

Overview

Fields

Protected foptionsdock: optionsdockty;
Protected fr: prectaccessty;
Protected fw: pwidgetaccessty;
Protected fplacing: integer;
Protected fclickedbutton: dockbuttonrectty;
Protected fwidgetstate: widgetstatesty;

Methods

Protected procedure checkdirection;
Protected procedure objectevent(const sender: tobject; const event: objecteventty) override;
Protected function checkclickstate(const info: mouseeventinfoty): boolean override;
Protected procedure dokeypress(const sender: twidget; var info: keyeventinfoty) override;
Protected procedure drawxorpic(const ashow: boolean; var canvas1: tcanvas);
Protected procedure endmouseop1();
Protected procedure endmouseop2();
Protected procedure cancelsizing();
Protected function doclose(const awidget: twidget): boolean;
Protected procedure setmdistate(const avalue: mdistatety); virtual;
Protected procedure domdistatechanged(const oldstate,newstate: mdistatety); virtual;
Protected function dofloat(const adist: pointty): boolean; virtual;
Protected function dodock(const oldparent: tdockcontroller): boolean; virtual;
Protected procedure dochilddock(const awidget: twidget); virtual;
Protected procedure dochildfloat(const awidget: twidget); virtual;
Protected function docheckdock(const info: draginfoty): boolean; virtual;
Protected function dockdrag(const dragobj: tdockdragobject): boolean;
Protected procedure childstatechanged(const sender: twidget; const newstate,oldstate: widgetstatesty); virtual;
Protected function nogrip: boolean;
Protected function canfloat: boolean;
Protected procedure refused(const apos: pointty);
Protected function calclayout(const dragobject: tdockdragobject; const nonewplace: boolean): boolean;
Protected procedure setpickshape(const ashape: cursorshapety);
Protected procedure restorepickshape;
Protected function checkbuttonarea(const apos: pointty): dockbuttonrectty;
Protected procedure updatesplitterrects(const awidgets: widgetarty);
Protected procedure checksplitdir(var asplitdir: splitdirty);
Protected procedure setoptionsdock(const avalue: optionsdockty); virtual;
Protected function isfullarea: boolean;
Protected function istabed: boolean;
Protected function ismdi: boolean;
Protected function isfloating: boolean;
Protected function canmdisize: boolean;
Protected procedure dolayoutchanged; virtual;
Protected procedure doboundschanged;
Protected procedure docaptionchanged;
Protected function findbandpos(const apos: integer; out aindex: integer; out arect: rectty): boolean;
Protected function findbandwidget(const apos: pointty; out aindex: integer; out arect: rectty): boolean;
Protected function findbandindex(const widgetindex: integer; out aindex: integer; out arect: rectty): boolean;
Protected function nofit: boolean;
Protected function writechild(const index: integer): msestring;
Protected procedure readchildrencount(const acount: integer);
Protected procedure readchild(const index: integer; const avalue: msestring);
Protected procedure receiveevent(const aevent: tobjectevent); override;
Protected function canbegindrag: boolean; override;
Protected procedure dostatplace(const aparent: twidget; const avisible: boolean; arect: rectty); virtual;
Protected procedure updatetabpage(const sender: ttabpage);
Public constructor create(aintf: idockcontroller);
Public destructor destroy; override;
Public function beforedragevent(var info: draginfoty): boolean; override;
Public procedure enddrag; override;
Public procedure mouseevent(var info: mouseeventinfoty); override;
Public procedure clientmouseevent(var info: mouseeventinfoty); override;
Public procedure childormouseevent(const sender: twidget; var info: mouseeventinfoty); override;
Public procedure checkmouseactivate(const sender: twidget; var info: mouseeventinfoty);
Public procedure dopaint(const acanvas: tcanvas);
Public procedure doactivate;
Public procedure sizechanged(force: boolean = false; scalefixedalso: boolean = false; const awidgets: widgetarty = nil);
Public procedure parentchanged(const sender: twidget);
Public procedure poschanged;
Public procedure statechanged(const astate: widgetstatesty); virtual;
Public procedure widgetregionchanged(const sender: twidget);
Public procedure updateminscrollsize(var asize: sizety);
Public procedure beginclientrectchanged;
Public procedure endclientrectchanged;
Public procedure beginplacement();
Public procedure endplacement();
Public procedure layoutchanged;
Public procedure dostatread(const reader: tstatreader);
Public procedure dostatwrite(const writer: tstatwriter; const bounds: prectty = nil);
Public procedure statreading;
Public procedure statread;
Public function getdockcaption: msestring;
Public function getfloatcaption: msestring;
Public function getitems: widgetarty;
Public function getwidget: twidget;
Public function activewidget: twidget;
Public function getparentcontroller( out acontroller: tdockcontroller): boolean; overload;
Public function getparentcontroller: tdockcontroller; overload;
Public function dockparentname(): string;
Public function childicon(): tmaskedbitmap virtual;
Public function close: boolean;
Public function closeactivewidget: boolean;
Public function float(): boolean;
Public function dockto(const dest: tdockcontroller; const apos: pointty): boolean;
Public procedure dock(const source: tdockcontroller; const arect: rectty);

Properties

Protected property useroptions: optionsdockty read fuseroptions write setuseroptions default defaultoptionsdock;
Public property tabwidget: ttabwidget read ftabwidget;
Public property activetabpage: ttabpage read getactivetabpage;
Public property mdistate: mdistatety read fmdistate write setmdistate;
Public property currentsplitdir: splitdirty read fsplitdir write setcurrentsplitdir;
Public property dockrect: rectty read getdockrect;
Published property dockhandle: tdockhandle read fdockhandle write setdockhandle;
Published property splitter_size: integer read fsplitter_size write setsplitter_size default defaultsplittersize;
Published property splitter_grip: stockbitmapty read fsplitter_grip write setsplitter_setgrip default defaultsplittergrip;
Published property splitter_color: colorty read fsplitter_color write setsplitter_color default defaultsplittercolor;
Published property splitter_colorgrip: colorty read fsplitter_colorgrip write setsplitter_colorgrip default defaultsplittercolorgrip;
Published property tab_options: tabbaroptionsty read ftab_options write settab_options default defaulttaboptions;
Published property tab_textflags: textflagsty read ftab_textflags write settab_textflags default defaultcaptiontextflags;
Published property tab_width: integer read ftab_width write settab_width default 0;
Published property tab_widthmin: integer read ftab_widthmin write settab_widthmin default 0;
Published property tab_widthmax: integer read ftab_widthmax write settab_widthmax default 0;
Published property tab_frame: tframecomp read ftab_frame write settab_frame;
Published property tab_face: tfacecomp read ftab_face write settab_face;
Published property tab_color: colorty read ftab_color write settab_color default cl_default;
Published property tab_colortab: colorty read ftab_colortab write settab_colortab default cl_transparent;
Published property tab_coloractivetab: colorty read ftab_coloractivetab write settab_coloractivetab default cl_active;
Published property tab_frametab: tframecomp read ftab_frametab write settab_frametab;
Published property tab_facetab: tfacecomp read ftab_facetab write settab_facetab;
Published property tab_faceactivetab: tfacecomp read ftab_faceactivetab write settab_faceactivetab;
Published property tab_size: integer read ftab_size write settab_size default 0;
Published property tab_sizemin: integer read ftab_sizemin write settab_sizemin default defaulttabsizemin;
Published property tab_sizemax: integer read ftab_sizemax write settab_sizemax default defaulttabsizemax;
Published property colortab: colorty read fcolortab write setcolortab default cl_default;
Published property coloractivetab: colorty read fcoloractivetab write setcoloractivetab default cl_default;
Published property facetab: tfacecomp read ffacetab write setfacetab;
Published property faceactivetab: tfacecomp read ffaceactivetab write setfaceactivetab;
Published property caption: msestring read fcaption write setcaption;
Published property splitdir: splitdirty read fdefaultsplitdir write setsplitdir default sd_none;
Published property optionsdock: optionsdockty read foptionsdock write setoptionsdock default defaultoptionsdock;
Published property bandgap: integer read fbandgap write setbandgap default 0;
Published property oncalclayout: docklayouteventty read foncalclayout write foncalclayout;
Published property onlayoutchanged: dockcontrollereventty read fonlayoutchanged write fonlayoutchanged;
Published property onboundschanged: dockcontrollereventty read fonboundschanged write fonboundschanged;
Published property oncaptionchanged: dockcontrollereventty read foncaptionchanged write foncaptionchanged;
Published property onbeforefloat: dockrecteventty read fonbeforefloat write fonbeforefloat;
Published property onfloat: notifyeventty read fonfloat write fonfloat;
Published property ondock: notifyeventty read fondock write fondock;
Published property onchilddock: widgeteventty read fonchilddock write fonchilddock;
Published property onchildfloat: widgeteventty read fonchildfloat write fonchildfloat;
Published property oncheckdock: checkdockeventty read foncheckdock write foncheckdock;
Published property onmdistatechanged: mdistatechangedeventty read fonmdistatechanged write fonmdistatechanged;

Description

Fields

Protected foptionsdock: optionsdockty;
 
Protected fr: prectaccessty;
 
Protected fw: pwidgetaccessty;
 
Protected fplacing: integer;
 
Protected fclickedbutton: dockbuttonrectty;
 
Protected fwidgetstate: widgetstatesty;
 

Methods

Protected procedure checkdirection;
 
Protected procedure objectevent(const sender: tobject; const event: objecteventty) override;
 
Protected function checkclickstate(const info: mouseeventinfoty): boolean override;
 
Protected procedure dokeypress(const sender: twidget; var info: keyeventinfoty) override;
 
Protected procedure drawxorpic(const ashow: boolean; var canvas1: tcanvas);
 
Protected procedure endmouseop1();
 
Protected procedure endmouseop2();
 
Protected procedure cancelsizing();
 
Protected function doclose(const awidget: twidget): boolean;
 
Protected procedure setmdistate(const avalue: mdistatety); virtual;
 
Protected procedure domdistatechanged(const oldstate,newstate: mdistatety); virtual;
 
Protected function dofloat(const adist: pointty): boolean; virtual;
 
Protected function dodock(const oldparent: tdockcontroller): boolean; virtual;
 
Protected procedure dochilddock(const awidget: twidget); virtual;
 
Protected procedure dochildfloat(const awidget: twidget); virtual;
 
Protected function docheckdock(const info: draginfoty): boolean; virtual;
 
Protected function dockdrag(const dragobj: tdockdragobject): boolean;
 
Protected procedure childstatechanged(const sender: twidget; const newstate,oldstate: widgetstatesty); virtual;
 
Protected function nogrip: boolean;
 
Protected function canfloat: boolean;
 
Protected procedure refused(const apos: pointty);
 
Protected function calclayout(const dragobject: tdockdragobject; const nonewplace: boolean): boolean;
 
Protected procedure setpickshape(const ashape: cursorshapety);
 
Protected procedure restorepickshape;
 
Protected function checkbuttonarea(const apos: pointty): dockbuttonrectty;
 
Protected procedure updatesplitterrects(const awidgets: widgetarty);
 
Protected procedure checksplitdir(var asplitdir: splitdirty);
 
Protected procedure setoptionsdock(const avalue: optionsdockty); virtual;
 
Protected function isfullarea: boolean;
 
Protected function istabed: boolean;
 
Protected function ismdi: boolean;
 
Protected function isfloating: boolean;
 
Protected function canmdisize: boolean;
 
Protected procedure dolayoutchanged; virtual;
 
Protected procedure doboundschanged;
 
Protected procedure docaptionchanged;
 
Protected function findbandpos(const apos: integer; out aindex: integer; out arect: rectty): boolean;
 
Protected function findbandwidget(const apos: pointty; out aindex: integer; out arect: rectty): boolean;
 
Protected function findbandindex(const widgetindex: integer; out aindex: integer; out arect: rectty): boolean;
 
Protected function nofit: boolean;
 
Protected function writechild(const index: integer): msestring;
 
Protected procedure readchildrencount(const acount: integer);
 
Protected procedure readchild(const index: integer; const avalue: msestring);
 
Protected procedure receiveevent(const aevent: tobjectevent); override;
 
Protected function canbegindrag: boolean; override;
 
Protected procedure dostatplace(const aparent: twidget; const avisible: boolean; arect: rectty); virtual;
 
Protected procedure updatetabpage(const sender: ttabpage);
 
Public constructor create(aintf: idockcontroller);
 
Public destructor destroy; override;
 
Public function beforedragevent(var info: draginfoty): boolean; override;
 
Public procedure enddrag; override;
 
Public procedure mouseevent(var info: mouseeventinfoty); override;
 
Public procedure clientmouseevent(var info: mouseeventinfoty); override;
 
Public procedure childormouseevent(const sender: twidget; var info: mouseeventinfoty); override;
 
Public procedure checkmouseactivate(const sender: twidget; var info: mouseeventinfoty);
 
Public procedure dopaint(const acanvas: tcanvas);
 
Public procedure doactivate;
 
Public procedure sizechanged(force: boolean = false; scalefixedalso: boolean = false; const awidgets: widgetarty = nil);
 
Public procedure parentchanged(const sender: twidget);
 
Public procedure poschanged;
 
Public procedure statechanged(const astate: widgetstatesty); virtual;
 
Public procedure widgetregionchanged(const sender: twidget);
 
Public procedure updateminscrollsize(var asize: sizety);
 
Public procedure beginclientrectchanged;
 
Public procedure endclientrectchanged;
 
Public procedure beginplacement();
 
Public procedure endplacement();
 
Public procedure layoutchanged;
 
Public procedure dostatread(const reader: tstatreader);
 
Public procedure dostatwrite(const writer: tstatwriter; const bounds: prectty = nil);
 
Public procedure statreading;
 
Public procedure statread;
 
Public function getdockcaption: msestring;
 
Public function getfloatcaption: msestring;
 
Public function getitems: widgetarty;
 
Public function getwidget: twidget;
 
Public function activewidget: twidget;
 
Public function getparentcontroller( out acontroller: tdockcontroller): boolean; overload;
 
Public function getparentcontroller: tdockcontroller; overload;
 
Public function dockparentname(): string;
 
Public function childicon(): tmaskedbitmap virtual;
 
Public function close: boolean;
 
Public function closeactivewidget: boolean;
 
Public function float(): boolean;
 
Public function dockto(const dest: tdockcontroller; const apos: pointty): boolean;
 
Public procedure dock(const source: tdockcontroller; const arect: rectty);
 

Properties

Protected property useroptions: optionsdockty read fuseroptions write setuseroptions default defaultoptionsdock;
 
Public property tabwidget: ttabwidget read ftabwidget;
 
Public property activetabpage: ttabpage read getactivetabpage;
 
Public property mdistate: mdistatety read fmdistate write setmdistate;
 
Public property currentsplitdir: splitdirty read fsplitdir write setcurrentsplitdir;
 
Public property dockrect: rectty read getdockrect;
 
Published property dockhandle: tdockhandle read fdockhandle write setdockhandle;
 
Published property splitter_size: integer read fsplitter_size write setsplitter_size default defaultsplittersize;
 
Published property splitter_grip: stockbitmapty read fsplitter_grip write setsplitter_setgrip default defaultsplittergrip;
 
Published property splitter_color: colorty read fsplitter_color write setsplitter_color default defaultsplittercolor;
 
Published property splitter_colorgrip: colorty read fsplitter_colorgrip write setsplitter_colorgrip default defaultsplittercolorgrip;
 
Published property tab_options: tabbaroptionsty read ftab_options write settab_options default defaulttaboptions;
 
Published property tab_textflags: textflagsty read ftab_textflags write settab_textflags default defaultcaptiontextflags;
 
Published property tab_width: integer read ftab_width write settab_width default 0;
 
Published property tab_widthmin: integer read ftab_widthmin write settab_widthmin default 0;
 
Published property tab_widthmax: integer read ftab_widthmax write settab_widthmax default 0;
 
Published property tab_frame: tframecomp read ftab_frame write settab_frame;
 
Published property tab_face: tfacecomp read ftab_face write settab_face;
 
Published property tab_color: colorty read ftab_color write settab_color default cl_default;
 
Published property tab_colortab: colorty read ftab_colortab write settab_colortab default cl_transparent;
 
Published property tab_coloractivetab: colorty read ftab_coloractivetab write settab_coloractivetab default cl_active;
 
Published property tab_frametab: tframecomp read ftab_frametab write settab_frametab;
 
Published property tab_facetab: tfacecomp read ftab_facetab write settab_facetab;
 
Published property tab_faceactivetab: tfacecomp read ftab_faceactivetab write settab_faceactivetab;
 
Published property tab_size: integer read ftab_size write settab_size default 0;
 
Published property tab_sizemin: integer read ftab_sizemin write settab_sizemin default defaulttabsizemin;
 
Published property tab_sizemax: integer read ftab_sizemax write settab_sizemax default defaulttabsizemax;
 
Published property colortab: colorty read fcolortab write setcolortab default cl_default;
 
Published property coloractivetab: colorty read fcoloractivetab write setcoloractivetab default cl_default;
 
Published property facetab: tfacecomp read ffacetab write setfacetab;
 
Published property faceactivetab: tfacecomp read ffaceactivetab write setfaceactivetab;
 
Published property caption: msestring read fcaption write setcaption;
 
Published property splitdir: splitdirty read fdefaultsplitdir write setsplitdir default sd_none;
 
Published property optionsdock: optionsdockty read foptionsdock write setoptionsdock default defaultoptionsdock;
 
Published property bandgap: integer read fbandgap write setbandgap default 0;
 
Published property oncalclayout: docklayouteventty read foncalclayout write foncalclayout;
 
Published property onlayoutchanged: dockcontrollereventty read fonlayoutchanged write fonlayoutchanged;
 
Published property onboundschanged: dockcontrollereventty read fonboundschanged write fonboundschanged;
 
Published property oncaptionchanged: dockcontrollereventty read foncaptionchanged write foncaptionchanged;
 
Published property onbeforefloat: dockrecteventty read fonbeforefloat write fonbeforefloat;
 
Published property onfloat: notifyeventty read fonfloat write fonfloat;
 
Published property ondock: notifyeventty read fondock write fondock;
 
Published property onchilddock: widgeteventty read fonchilddock write fonchilddock;
 
Published property onchildfloat: widgeteventty read fonchildfloat write fonchildfloat;
 
Published property oncheckdock: checkdockeventty read foncheckdock write foncheckdock;
 
Published property onmdistatechanged: mdistatechangedeventty read fonmdistatechanged write fonmdistatechanged;
 
Generated by PasDoc 0.16.0.