#Balloon

C
Control
R
Control

Delay
P
i

Font
P
Font

Visible
R
b

_call
M

(Message)s(Control)Control;[(Icon)Picture;(X)i(Y)i]
Info
M

(Message)s(Control)Control;[(X)i(Y)i]
Warning
M

(Message)s(Control)Control;[(X)i(Y)i]
Error
M

(Message)s(Control)Control;[(X)i(Y)i]
Question
M

(Message)s(Control)Control;[(X)i(Y)i]
Delete
M

(Message)s(Control)Control;[(X)i(Y)i]
Hide
M

[(Control)Control;]
#Bookmarks

C
'This class allows to globally manage a list of file bookmarks.
Count
R
i

'Return the number of bookmarks.
_Age
V
i

Add
M

(Path)s[(Name)s(Icon)s]
'Add a new bookmark to the list.
'
'- ~Path~ is the file path of the bookmark.
'- ~Name~ is the name of the bookmark.
'- ~Icon~ is the name of the stock icon associated with the bookmark.
Remove
M

(Path)s
'Remove all bookmarks associated with a specific path.
Clear
M


'Remove all bookmarks.
_GetAll
M
Bookmark[]

TimerUpdate_Timer
M


#ButtonBox
UserControl
C
_Properties
C
s
"*,Action,Text,Alignment{Align.Normal;Left;Center;Right}=Normal,Picture,ReadOnly,Placeholder,Password,Border=True,Button=True,ClearButton,Filter,FilterMenu{Menu},FilterPicture"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"TextBox"
:Click
:


:Change
:


:Activate
:


:Clear
:


:Filter
:


:Validate
:


'--> ../../maskbox/.validate
Picture
p
Picture

Text
p
s

Pos
p
i

Length
r
i

ReadOnly
p
b

Border
p
b

Editor
r
MaskBox

Button
p
b

Alignment
p
i

ClearButton
p
b

Filter
p
b

FilterMenu
p
s

Placeholder
p
s

Password
p
b

FilterPicture
p
Picture

'@{since 3.19}
'
'Return or set the picture displayed in the filter icon.
'
'A default one is used if none is specified.
_new
m


Button_Click
m


Background_GotFocus
m


Clear
m


Background_Arrange
m


Background_Draw
m


TextBox_GotFocus
m


TextBox_LostFocus
m


TextBox_Activate
m


TextBox_Validate
m


TextBox_Change
m


_AddButton
m

(hButton)ToolButton;
ClearButton_Click
m


FilterNow
m


FilterTimer_Timer
m


FilterPictureBox_MouseDown
m


#ColorButton
UserControl
C
:Change
:


:Click
:


Color
p
i

Value
p
i

Border
p
b

_Properties
C
s
"*,Value{Color},Border=True"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"8,4"
_new
m


DrawingArea_Draw
m


DrawingArea_MouseDown
m


DrawingArea_MouseMove
m


DrawingArea_MouseUp
m


DrawingArea_Enter
m


DrawingArea_Leave
m


DrawingArea_GotFocus
m


DrawingArea_LostFocus
m


#ColorChooser
UserControl
C
:Change
:


:Activate
:


_Properties
C
s
"*,Border=True,ShowAlpha,ShowColorMap=True,ShowCustom"
_DefaultEvent
C
s
"Change"
_DefaultSize
C
s
"36,36"
_Group
C
s
"Chooser"
SelectedColor
p
i

Value
p
i

ShowAlpha
p
b

ShowColorMap
p
b

ShowCustom
p
b

Border
p
b

_new
m


_RaiseChange
m


_RaiseActivate
m


#ColorPalette
UserControl
C
_Properties
C
s
"*,Border=True,ReadOnly,Size"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"36,4"
_Group
C
s
"Chooser"
:Click
:


:Activate
:


Border
p
b

Colors
p
Integer[]

Index
p
i

Current
p
i

ReadOnly
p
b

Size
p
i

'@{since 3.19}
'
'Return or set the pixel size of a color button.
'
'If the size is lower or equal than zero (the default value), a default size is used.
_new
m


View_Arrange
m


View_MouseMove
m


Clear
m


Add
m

(Color)i
AddFirst
m

(Color)i
Exist
m
b
(Color)i
View_Draw
m


View_MouseDown
m


View_Menu
m


View_DblClick
m


View_Leave
m


View_Scroll
m


mnuRemove_Click
m


mnuRemoveAll_Click
m


mnuSort_Click
m


View_MouseWheel
m


#Completion

C
:Activate
:


List
v
String[]

Icons
v
String[]

Start
v
i

Delay
p
i

Editor
p
Control

_new
m

(Target)Control;
'Create a new automatic completion on the specified control.
'
'~Target~ is assigned to the [../editor] property. 
Open
m


Timer_Timer
m


Close
m


TextBox_Change
m


TextBox_KeyPress
m


GridView_MouseUp
m


Fill
m

(Text)s(Explicit)b
TextBox_Hide
m


TextBox_Move
m


TextBox_Resize
m


TextBox_LostFocus
m


GridView_GotFocus
m


GridView_Data
m

(Row)i(Column)i
Window_Move
m


#DateBox
UserControl
C
_Properties
C
s
"*,Action,Value,ReadOnly,Border=True,Mode{DateChooser.*}=DateOnly"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"TextBox"
_Group
C
s
"Chooser"
:Activate
:


:Click
:


:Change
:


Value
p
d

ReadOnly
p
b

Border
p
b

Mode
p
i

Text
r
s

Editor
r
MaskBox

'Return the inner [../../maskbox] control used for editing the date.
_new
m


ButtonBox_Click
m


ButtonBox_KeyPress
m


ButtonBox_Activate
m


ButtonBox_Change
m


PopupWindow_Open
m


DateChooser_Click
m


DateChooser_Cancel
m


#DateChooser
UserControl
C
Value
p
d

Year
p
i

Month
p
i

Day
p
i

Font
p
Font

Colors
r
_DateChooser_Colors

Mode
p
i

Data
r
_DateChooser_Data

Border
p
b

MinValue
p
d

MaxValue
p
d

ShowWeek
p
b

'Return or set if the week numbers are visible.
DateOnly
C
i
0
DateTime
C
i
1
TimeOnly
C
i
2
:Change
:


:Click
:


:Activate
:


:Cancel
:


:Data
:

(Date)d
_Properties
C
s
"*,Border=True,Mode{DateChooser.*}=DateOnly,ShowWeek"
_DefaultEvent
C
s
"Change"
_DefaultSize
C
s
"40,28"
_Group
C
s
"Chooser"
_new
m


_Change
m


_Click
m


_Activate
m


_Cancel
m


SetFocus
m


_get
m
_DateChooser_Date
(Date)d
_GetData
m
_DateChooser_Data
(dDate)d[(bCreate)b]
#DirBox
UserControl
C
_Properties
C
s
"*,Path,Action,Title,Border=True"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"32,4"
_Similar
C
s
"TextBox"
_Group
C
s
"Chooser"
:Click
:


'Raised when a directory has been selected.
:Change
:


'Raised when the contents of the control has changed.
Value
p
s

'Return or set the selected directory.
Path
p
s

'Return or set the selected directory.
Border
p
b

'Return or set if the control has a border.
Title
p
s

'Return or set the title of the directory selection dialog.
Placeholder
p
s

'@{since 3.20}
'
'Return or set the placeholder tdext.
_new
m


Button_Click
m


Button_Change
m


#DirBrowser
UserControl
C
'This control implements an horizontal directory browser.
_Properties
C
s
"*,Border=True,Dir,Root,Text,Picture"
_DefaultEvent
C
s
"Click"
_Group
C
s
"View"
:Click
:

(Dir)s
'Raise when the user clicks on one of the directory buttons.
'
'- ~Dir~ is the path of the directory associated with the clicked button.
Dir
p
s

'Return or set the directory displayed by the control.
'
'### See also
'[../root]
Root
p
s

'Return or set the root directory, i.e. the directory of the first button.
'
'The [../dir] directory must be a sub-directory of the root directory.
Text
p
s

'Return or set the text of the root button.
'
'If not specified, the name of the root directory is used.
Picture
p
Picture

'Return or set the icon associated with the root button.
Border
p
b

'Return or set if the control has a border.
_new
m


'Create a new DirBrowser control.
DirButton_Click
m


#DirChooser
UserControl
C
_Properties
C
s
"*,Border=True,Root,Picture,View{FileView.Normal;Compact;Detailed;Preview}=Normal,ShowHidden,ShowFile,ShowBookmark=True,ShowSplitter=True,ShowToolbar=True"
_DefaultEvent
C
s
"Change"
_DefaultSize
C
s
"36,36"
_Group
C
s
"Chooser"
Root
p
s

Picture
p
Picture

SelectedPath
p
s

Value
p
s

ShowFile
p
b

ShowHidden
p
b

ShowDetailed
p
b

ShowBookmark
p
b

ShowSplitter
p
b

ShowPreview
p
b

View
p
i

'Return or set the view mode of the internal file view.
'
'### See also
'[../../fileview/view]
ShowToolbar
p
b

'Return or set if the toolbar is visible.
Bookmarks
p
Collection[]

Icon
p
Picture

Settings
p
Variant[]

DirView
r
DirView

FileView
r
FileView

Border
p
b

UncompressFilter
p
String[]

'Return or set a list of file filters that identify files that can be uncompressed in response of the [../.uncompress] event.
:Change
:


:Activate
:


:Icon
:

(Path)s
:Uncompress
:

(Path)s
'Raise when a specific compressed file must be uncompressed.
'
'- ~Path~ is the path of the compressed file.
_new
m


frmChooser_Open
m


frmChooser_Change
m


frmChooser_Select
m


frmChooser_GetIcon
m

(Path)s
frmChooser_Uncompress
m

(Path)s
Reload
m


#DirView
UserControl
C
_Properties
C
s
"*,Border=True,Root,Picture,ShowHidden,HideRoot"
_DefaultEvent
C
s
"Click"
_Group
C
s
"View"
:Select
:


:Click
:


:Activate
:


:Menu
:


:Icon
:

(Path)s
Root
p
s

Current
p
s

ShowHidden
p
b

Picture
p
Picture

Border
p
b

Icon
p
Picture

Renaming
r
b

Settings
p
Variant[]

HideRoot
p
b

_CheckComponents
M


_new
m


TreeView_Expand
m


TreeView_Collapse
m


TreeView_Select
m


TimerExpand_Timer
m


TreeView_Activate
m


TreeView_Menu
m


Refresh_Timer
m


_GetIcon
M
Picture
(sPath)s(iSize)i
TreeView_Rename
m


TreeView_Cancel
m


NewFolder
m


Rename
m


Reload
m


Watch_Create
m


Watch_Delete
m


Watch_MoveFrom
m


Watch_MoveTo
m


Watch_Move
m


Watcher_Show
m


Watcher_Hide
m


#DocumentView
UserControl
C
'This control implements a paged document viewer.
_Properties
C
s
"*,Border,Arrangement{Arrange.Row;Column;Vertical;Horizontal;Fill}=Row,Padding=16,Spacing=16,Columns,Center,ShowShadow,ShowPage"
_Group
C
s
"View"
_Similar
C
s
"GridView"
DocWidth
p
i

'Return or set the default width of a page in millimiters.
'
'By default the size of the page is 210 x 297 mm (A4 format).
PageWidth
p
i

'Return or set the default width of a page in millimiters.
'
'By default the size of the page is 210 x 297 mm (A4 format).
DocHeight
p
i

'Return or set the default height of a page in millimiters.
'
'By default the size of the page is 210 x 297 mm (A4 format).
PageHeight
p
i

'Return or set the default height of a page in millimiters.
'
'By default the size of the page is 210 x 297 mm (A4 format).
Count
p
i

'Return or set the number of pages in the document.
Max
r
i

'Return the number of pages in the document minus one.
Layout
r
_DocumentLayout

'Return a virtual object used for defining the layout of a specific page.
'
'See the [./.layout] event for more details.
Zoom
p
f

'Return or set the zoom factor of the view.
Scale
p
f

'Return or set the zoom factor of the view.
Columns
p
i

'Return or set the number of columns used for layouting pages.
'
'If set to zero (the default), then the preview only shows pages one by one.
'Otherwise all pages are layouted from top to bottom.
Column
p
i

'Return or set the number of columns used for layouting pages.
'
'If set to zero (the default), then the preview only shows pages one by one.
'Otherwise all pages are layouted from top to bottom.
Arrangement
p
i

'Return or set how the different pages are arranged inside the view.
'
'This property can take one of the following values:
'- [Arrange.Vertical](/comp/gb.qt4/arrange/vertical)
'- [Arrange.Horizontal](/comp/gb.qt4/arrange/horizontal)
'- [Arrange.Row](/comp/gb.qt4/arrange/row)
'- [Arrange.Column](/comp/gb.qt4/arrange/column)
'- [Arrange.Fill](/comp/gb.qt4/arrange/fill)
Padding
p
i

'Return or set the padding inside the view in millimiters.
Spacing
p
i

'Return or set the spacing between the different pages in millimiters.
ShowShadow
p
b

'Return or set if pages are drawn with a little shadow.
ShowPage
p
b

'Return or set if the page number must be displayed inside the view.
FirstVisiblePage
r
i

'Return the index of the first visible page.
FirstVisibleDocument
r
i

'Return the index of the first visible page.
LastVisiblePage
r
i

'Return the index of the last visible page.
LastVisibleDocument
r
i

'Return the index of the last visible page.
Center
p
b

'Return or set if the page must be centered in the view.
AutoCenter
p
b

'Return or set if the page must be centered in the view.
Border
p
b

'Return or set if the document view has a border.
Desaturate
p
b

'Return or set if the preview is automatically desaturated.
:Layout
:

(Page)i
'This event is raised so that each page layout can be defined independently.
'
'- ~Page~ is the index of the page to layout.
'
'Use the [../layout] property inside the handler of this event to define the layout of the specified page.
:Draw
:

(Page)i(Width)i(Height)i
'This event is raised when a specific page preview must me drawn
'
'- ~Page~ is the index of the page to draw.
'- ~Width~ and ~Height~ are the size of the image buffer where the page must be drawn.
:Finished
:


'This event is raised when all page preview have been drawn.
:Zoom
:


'This event is raised when the zoom level has changed.
_new
m


'Create a new DocumentView
tmrLoad_Timer
m


View_Draw
m


Find
m
i
(X)i(Y)i
'Return the page number under a specific mouse cursor position.
'
'- ~X~ and ~Y~ are the mouse cursor position relative to the document view.
View_Arrange
m


View_Scroll
m


Refresh
m


'Refresh the view contents.
Reset
m


'Resets the view.
tmrRefresh_Timer
m


Goto
m

(Page)i
'Move the view to a specified page.
'
'- ~Page~ is the page number, starting from zero.
View_MouseWheel
m


Obs_MouseWheel
m


_GetItemWidth
m
i
(Index)i
_GetItemHeight
m
i
(Index)i
_get
m
_DocumentItem
(Index)i
'Return a virtual object that represents a specific preview page.
'
'- ~Index~ is the index of the page.
View_MouseDown
m


View_MouseMove
m


View_MouseUp
m


_IsVisible
m
b
(Index)i
#Expander
UserContainer
C
_Properties
C
s
"*,Border=True,Text,TextFont,Animated,Hidden"
_DefaultEvent
C
s
"Show"
_Similar
C
s
"Panel"
:Show
:


:Hide
:


Hidden
p
b

Text
p
s

TextFont
p
Font

Animated
p
b

Border
p
b

_new
m


_Show
m


_Hide
m


#FileBox
UserControl
C
_Properties
C
s
"*,Path,Action,Border=True,SaveFile,Title,Filter,Picture,Placeholder"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"32,4"
_Similar
C
s
"TextBox,DirBox"
_Group
C
s
"Chooser"
:Click
:


'Raised when a file has been selected.
:Change
:


'Raised when the contents of the control has changed.
Value
p
s

'Return or set the selected file.
Path
p
s

'Return or set the selected file.
Border
p
b

'Return or set if the control has a border.
Title
p
s

'Return or set the title of the file selection dialog.
Picture
p
Picture

'Return or set the button image. The default one is a file icon.
Placeholder
p
s

'Return or set the placeholder tdext.
SaveFile
p
b

'Return or set if the file dialog will be opened for saving.
Filter
p
String[]

'Return or set the optional filters of the file selection dialog.
'
'The syntax is the same as the [Dialog.Filter](/comp/gb.qt4/dialog/filter) property.
_new
m


'Create a new FileBox control.
Button_Click
m


Button_Change
m


#FileChooser
UserControl
C
_Properties
C
s
"*,Border=True,Root,Picture,Multi,Filter,AutoExt,View{FileView.Normal;Compact;Detailed;Preview}=Normal,ShowHidden,ShowDirectory,ShowBookmark=True,ShowFile=True,ShowButton,ShowToolbar=True,Margin,ReadOnly"
_DefaultEvent
C
s
"Change"
_DefaultSize
C
s
"36,36"
_Group
C
s
"Chooser"
Root
p
s

Picture
p
Picture

Dir
p
s

SelectedPath
p
s

SelectedPaths
r
String[]

Value
p
v

Multi
p
b

ShowDirectory
p
b

ShowHidden
p
b

ShowDetailed
p
b

ShowBookmark
p
b

ShowFile
p
b

ShowPreview
p
b

View
p
i

'Return or set the view mode of the internal file view.
'
'### See also
'[../../fileview/view]
ShowToolbar
p
b

'Return or set if the toolbar is visible.
Bookmarks
p
Collection[]

Settings
p
Variant[]

DirView
r
DirView

FileView
r
FileView

ShowButton
p
b

Extension
r
Container

Border
p
b

Margin
p
b

AutoExt
p
b

'Return or set if the extension of the file is automatically set from the current filter.
ReadOnly
p
b

Filter
p
String[]

FilterIndex
p
i

Icon
p
Picture

UncompressFilter
p
String[]

'Return or set a list of file filters that identify files that can be uncompressed in response of the [../.uncompress] event.
:Change
:


:Activate
:


:Icon
:

(Path)s
:Cancel
:


:Uncompress
:

(Path)s
'Raise when a specific compressed file must be uncompressed.
'
'- ~Path~ is the path of the compressed file.
_new
m


frmChooser_Open
m


frmChooser_Change
m


frmChooser_Select
m


frmChooser_GetIcon
m

(Path)s
frmChooser_Uncompress
m

(Path)s
Reload
m


frmChooser_Cancel
m


SetFocus
m


#FileCompletion
Completion
C
_new
m


'Create a new FileCompletion on the target control.
Fill
m

(Text)s(Explicit)b
#FileProperties
UserControl
C
_Properties
C
s
"*,Border=True"
_DefaultSize
C
s
"36,36"
_Group
C
s
"View"
:Data
:


:Click
:


Path
p
s

Border
p
b

Data
r
_FilePropertiesData

Index
p
i

_new
m


Add
m
i
(Panel)Control;(Title)s
_RaiseData
m
_FilePropertiesData

_RaiseClick
m


#FileView
UserControl
C
_Properties
C
s
"*,Border=True,View{FileView.Normal;Compact;Detailed;Preview}=Normal,Mode{Select.*}=Single,Dir,ShowHidden,ShowDirectory"
_DefaultEvent
C
s
"Click"
_Group
C
s
"View"
Normal
C
i
0
'Constant for displaying files with the normal view.
Compact
C
i
1
'Constant for displaying files with a compact view.
Detailed
C
i
2
'Constant for displaying files with a detailed view.
Preview
C
i
3
'Constant for displaying files with their preview.
:Select
:


:Click
:


:Activate
:


:Menu
:


:Icon
:

(Path)s
Path
r
s

'Return the current selected path.
'
'It's an equivalent of '[../dir] &/ [../current]'.
:Refresh
:


'This event is raised just after the FileView has been refreshed.
:Rename
:

(OldName)s(NewName)s
'This event is raised when a file is being renamed.
'
'The renaming is cancelled if the event is stopped.
:Filter
:

(Name)s(Info)Stat;
'This event is raised for each file that may be displayed in the view.
'
'By cancelling this event, you prevent the file from being displayed.
:View
:


'@{since 3.19}
'
'This event is raised when the [../view] property has changed.
Dir
p
s

Current
p
s

Paths
r
String[]

'Return the absolute paths of the selected elements.
ShowHidden
p
b

ShowDirectory
p
b

Mode
p
i

ShowDetailed
p
b

ShowPreview
p
b

View
p
i

'Return or set the view mode of control.
'
'It can take one of the following value:
'- [../Normal] for a normal vertical icon view.
'- [../Compact] for a compact horizontal icon view.
'- [../Detailed] for a detailed view based on a ColumnView table.
'- [../Preview] for a vertical icon view with file preview.
Selection
p
String[]

Filter
p
String[]

Icon
p
Picture

IconSize
p
i

Border
p
b

Settings
p
Variant[]

Count
r
i

Background
p
i

Foreground
p
i

Selected
r
b

'Return if at least one item is selected in the view.
FileCount
r
i

'Return the number of files displayed by the view.
DirCount
r
i

'Return the number of directories displayed by the view.
TotalSize
r
l

'Return the total size of the files displayed by the view.
MaxPreviewSize
p
i

'Return or set the size limit in bytes of files that will be previewed.
'
'- If 'MaxPreviewSize' is zero (the default), the size limit is 4Mb.
'- If 'MaxPreviewSize' is negative, there is no size limit.
_init
M


_exit
M


_new
m


_GetHiddenColor
M
i

Watcher_Resize
m


Copy
m


'Copy the selected items as a list of URI in the clipboard.
TaskPreview_Read
m


TaskPreview_Error
m

(Data)s
TaskPreview_Kill
m


Refresh_Timer
m


Reload
m

[(ClearCache)b]
'Refresh the view contents.
'
'If ~ClearCache~ is 'TRUE', then the preview are refreshed.
EnsureVisible_Timer
m


UnselectAll
m


View_Select
m


View_Click
m


View_Activate
m


View_Menu
m


View_BeforeSort
m


View_Compare
m

(Key)s(OtherKey)s
SelectAll
m


Rename
m


View_Rename
m


Watch_Create
m


Watch_Delete
m


Watch_MoveFrom
m


Watch_MoveTo
m


Watch_Stat
m


_attach
m

(Parent)o(EventName)s
Watcher_Hide
m


Watcher_Show
m


_RefreshPicture
m


View_MouseDrag
m


View_DragLeave
m


View_Drop
m


View_DragMove
m


View_Scroll
m


UserControl_Font
m


#FontBox
UserControl
C
_Properties
C
s
"*,Action,Border=True"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"32,4"
_Similar
C
s
"TextBox"
_Group
C
s
"Chooser"
:Click
:


:Change
:


Value
p
s

Border
p
b

Default
p
s

_new
m


ButtonBox_Click
m


ButtonBox_Clear
m


ButtonBox_KeyPress
m


#FontChooser
UserControl
C
:Change
:


:Activate
:


_Properties
C
s
"*,Border=True,FixedOnly,ShowStyle=True,ShowPreview=True,ShowRelative=True,ShowFont=True"
_DefaultEvent
C
s
"Change"
_DefaultSize
C
s
"36,36"
_Group
C
s
"Chooser"
SelectedFont
p
s

Value
p
s

FixedOnly
p
b

ShowStyle
p
b

ShowPreview
p
b

ShowLabel
p
b

ShowRelative
p
b

ShowFont
p
b

'Return or set if font preview is displayed
Border
p
b

_new
m


_Change
m


_Activate
m


#IconPanel
UserContainer
C
_Properties
C
s
"*,Count{Range:1;256}=1,Index,Text,TextFont,Picture,Border"
_Similar
C
s
"TabStrip"
_IsMultiContainer
C
b
T
_DefaultEvent
C
s
"Click"
:Click
:


Count
p
i

Index
p
i

Text
p
s

Picture
p
Picture

TextFont
p
Font

Border
p
b

Background
p
i

'Return or set the control background.
_new
m


_UpdateIconViewWidth
m


Panel_Arrange
m


_get
m
_IconPanelContainer
(Index)i
View_Font
m


_GetView
m
GridView

_GetIndex
m
i
(hCont)_IconPanelContainer;
View_Select
m


View_MouseWheel
m


View_KeyPress
m


_SetVisible
m

(hCont)_IconPanelContainer;(bVisible)b
View_Draw
m

(X)i(Y)i(Width)i(Height)i(Row)i(Column)i
FindPanel
m
i
(Text)s
'Return the index of the first panel having a specific title.
'
'- ~Text~ : panel title to search for.
'
''-1' is returned if no panel is found.
#ImageView
UserControl
C
_Properties
C
s
"*,Border=True,Alignment{Align.*}=Center,Grid,UseMouse=True"
_DefaultSize
C
s
"36,36"
_Group
C
s
"View"
_DrawWith
C
s
"DrawingArea"
:Draw
:

(View)Image;
View
r
ScrollArea

Image
p
Image

:Scroll
:


:Resize
:


Border
p
b

Zoom
p
f

Design
p
b

Grid
p
b

UseMouse
p
b

Alignment
p
i

ScrollX
p
i

ScrollY
p
i

ScrollWidth
r
i

ScrollW
r
i

ScrollHeight
r
i

ScrollH
r
i

_new
m


View_Arrange
m


Scroll
m

(X)i(Y)i
ViewToImage
m
Point
(ViewPoint)Point;
ImageToView
m
Point
(ImagePoint)Point;
_Paint
m

(hImage)Image;(X)f(Y)f[(hRect)Rect;]
View_Draw
m


View_MouseDown
m


View_MouseMove
m


View_MouseWheel
m


Update
m

[(Image)Image;]
ZoomFit
m

[(Margin)i]
View_Scroll
m


View_Resize
m


EnsureVisible
m

(X)i(Y)i(W)i(H)i
#InputBox

C
_call
M
s
(Prompt)s[(Title)s(Default)s]
#LCDLabel
UserControl
C
_Properties
C
s
"*,Text,Alignment{Align.Normal;Left;Center;Right}=Normal,Sheared,Padding{Range:0;63},Border,HighlightColor{Color}"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"Label"
Text
p
s

Alignment
p
i

Sheared
p
b

Padding
p
i

Border
p
b

HighlightColor
p
i

Value
p
f

_new
m


View_Draw
m


#ListContainer
UserContainer
C
_Properties
C
s
"*,-Padding,-Spacing,-Arrangement,-AutoResize,-Indent,Border=True"
_DefaultArrangement
C
s
"V"
_DefaultEvent
C
s
"Click"
_Group
C
s
"Deprecated"
:Click
:


:Activate
:


:Scroll
:


Count
r
i

Index
p
i

Current
p
Control

Background
p
i

Border
p
b

_new
m


ScrollView_NewChild
m

(Child)Control;
Child_NewChild
m

(Child)Control;
ScrollView_Scroll
m


Child_Insert
m

(Child)Control;
EnsureVisible
m


Child_MouseDown
m


Child_MouseMove
m


Child_MouseUp
m


Child_Timer
m


Child_DblClick
m


Select
m

(hChild)Control;
Clear
m


Lock
m


Unlock
m


ScrollView_KeyPress
m


#ListEditor
UserControl
C
_Properties
C
s
"*,List,Border=True,Grid,Moveable=True,ReadOnly,Wrap,Unique"
_DefaultSize
C
s
"24,32"
_Similar
C
s
"ListBox"
_Group
C
s
"View"
List
p
String[]

Border
p
b

Text
p
s

Moveable
p
b

ReadOnly
p
b

Editor
r
Control

Wrap
p
b

'Return or set if the item text must wrap and the item height expands automatically.
Grid
p
b

'Return or set if a grid should be displayed between the items.
Unique
p
b

'Return or set if duplicates are allowed in the list.
'
'By default, this property is 'FALSE' and duplicates are allowed.
Index
p
i

'Return or set the index of the current item.
'
''-1' means that there is no current item.
:Select
:


:Change
:


:Add
:


:Activate
:


'This event is raised when an item is double-clicked.
_new
m


_RaiseSelect
m


_RaiseChange
m


_RaiseAdd
m


Add
m

(Text)s
Remove
m

(Index)i[(Length)i]
'Remove one or more items from the list.
'
'- ~Index~ is the index of the first item to remove.
'- ~Length~ is the number of items to remove from the specified index. One item is removed by default.
_RaiseActivate
m


Clear
m


'Clear the list.
Find
m
i
(Text)s[(Mode)i]
'Find an item in the list and return its index.
'
'- ~Text~ is the text of the item.
'- ~Mode~ is one of the [/lang/compmethod].
'
'If no item is found, '-1' is returned.
#MaskBox
TextBox
C
_Properties
C
s
"*,-Password,-MaxLength,Action,Filter,Mask,ShowDefault,Prompt{MaskBox.*}"
_Similar
C
s
"TextBox"
_DrawWith
C
s
"TextBox"
Space
C
i
0
Underscore
C
i
1
Bracket
C
i
2
Dash
C
i
3
Square
C
i
4
Circle
C
i
5
:Filter
:

(Char)s
:Validate
:


'This event is raised when the contents of the control changes so that you can validate the new contents.
'
'Stop the event to restore the old contents if the new contents is not valid.
Mask
p
s

Filter
p
s

ShowDefault
p
b

Text
p
s

Prompt
p
i

_new
m


Clear
m


TextBox_KeyPress
m


TextBox_GotFocus
m


TextBox_Change
m


TextBox_LostFocus
m


#MenuButton
UserControl
C
_Properties
C
s
"*,Action,AutoResize,Text,Picture,Arrow=True,Border=True,Menu,MenuOnly"
_DefaultSize
C
s
"6,4"
_Similar
C
s
"Button"
_DefaultEvent
C
s
"Click"
:Click
:


Picture
p
Picture

Text
p
s

Menu
p
s

Arrow
p
b

MenuOnly
p
b

Value
p
b

AutoResize
p
b

Border
p
b

Background
p
i

_new
m


Button_GotFocus
m


Button_Click
m


WatchTimer_Timer
m


_RestoreFocus
m


DrawingArea_MouseUp
m


TimerMenu_Timer
m


DrawingArea_GotFocus
m


DrawingArea_LostFocus
m


DrawingArea_Enter
m


DrawingArea_Leave
m


DrawingArea_MouseDown
m


DrawingArea_MouseMove
m


DrawingArea_Draw
m


DrawingArea_KeyPress
m


DrawingArea_KeyRelease
m


DrawingArea_Font
m


DrawingArea_Change
m


#Message

C
Optional
M
i
(Message)s(Button)s(Key)s[(Icon)s(Force)b]
#MessageView
UserControl
C
_Properties
C
s
"*,Border,Animated,Separator"
_DefaultSize
C
s
"32,6"
_Group
C
s
"View"
_DrawWith
C
s
"DrawingArea"
:Open
:


:Close
:


Animated
p
b

Separator
p
b

Border
p
b

_new
m


Open
m

(Text)s[(Icon)Picture;]
Close
m


View_Arrange
m


View_DblClick
m


CloseButton_Click
m


View_Draw
m


#SidePanel
UserContainer
C
_Properties
C
s
"*,Action,Orientation{Align.Top;Bottom;Left;Right}=Top,Resizable=True,ShowButtons=True,AutoHide,Border,Separator,Transparent,Hidden"
_Similar
C
s
"Panel"
:Show
:


:Hide
:


:Resize
:


Orientation
p
i

Border
p
b

Separator
p
b

Hidden
p
b

Resizable
p
b

Dimension
p
i

Tooltip
p
s

Value
p
b

Action
p
s

Design
p
b

Settings
p
Variant[]

Transparent
p
b

MinSize
p
i

AutoHide
p
b

'Return or set if the side panel is automatically hidden after a short time.
ShowButtons
p
b

'Return or set if the little arrow buttons that toggle the panels should be visible.
'
'This property is 'TRUE' by default.
_new
m


Observer_Arrange
m


_Show
m


_Hide
m


_Resize
m


#SliderBox
UserControl
C
_Properties
C
s
"*,Picture,MinValue=0,MaxValue=100,Step=1,DefaultValue,Value"
_DefaultEvent
C
s
"Change"
_DefaultSize
C
s
"32,4"
_Similar
C
s
"Slider"
:Change
:


Value
p
i

MinValue
p
i

MaxValue
p
i

Step
p
i

DefaultValue
p
i

Font
p
Font

Picture
p
Picture

_new
m


UserControl_Resize
m


Slider_Change
m


SpinBox_Change
m


SpinBox_MouseWheel
m


SpinBox_DblClick
m


SpinBox_KeyPress
m


#SpinBar
UserControl
C
_Properties
C
s
"*,Border=True,Value,MaxValue=1.0,MinValue,Text,Step=0.1"
_DefaultEvent
C
s
"Change"
_DefaultSize
C
s
"32,4"
_Similar
C
s
"Slider"
:Change
:


Value
p
f

MaxValue
p
f

MinValue
p
f

Text
p
s

Step
p
f

Background
p
i

Border
p
b

_new
m


View_MouseMove
m


View_MouseDown
m


View_MouseUp
m


Timer_Timer
m


View_MouseWheel
m


View_DblClick
m


View_Draw
m


View_Arrange
m


View_Leave
m


Text_LostFocus
m


Text_GotFocus
m


Text_KeyPress
m


Text_MouseWheel
m


View_Font
m


#Spinner
UserControl
C
_Properties
C
s
"*,Border,Label,Padding{Range:0;63},Margin=False,Type={Spinner.*}"
_DefaultSize
C
s
"8,8"
Line
C
i
0
'Spinner type drawing lines.
Dot
C
i
1
'Spinner type drawing dots.
Circle
C
i
2
'Spinner type drawing a ring.
Border
p
b

Label
p
b

Value
p
f

Enabled
p
b

Padding
p
i

Margin
p
b

'@{since 3.16}
'
'Return or set if there is an inner margin between the spinner and the control border.
Type
p
i

'@{since 3.16}
'
'Return or set the Spinner type.
'
'The following types are implemented: [../line], [../dot], [../circle].
'
'The default type is [../line].
Start
m


Stop
m


Wait
m


UserControl_Draw
m


Timer_Timer
m


#Stock

C
Debug
P
b

List
R
String[]

Themes
R
String[]

Icons
R
String[]

Sizes
R
String[]

Flags
R
String[]

'@{since 3.19}
'
'Return the names of all flag icons.
GetSize
M
i
(Size)s
_get
M
Picture
(Key)s[(Default)s]
Refresh
M


GetFlag
M
Picture
(Key)s
'@{since 3.19}
'
'Return a flag icon from its key.
'
'- ~Key~ : the icon key, following the format `<size>/<name>`.
'
#SwitchButton
UserControl
C
_Properties
C
s
"*,Action,Value"
_DefaultEvent
C
s
"Click"
_DefaultSize
C
s
"16,4"
_Similar
C
s
"Button"
:Click
:


Value
p
b

Animated
p
b

Background
p
i

_new
m


DrawingArea_Draw
m


DrawingArea_Enter
m


DrawingArea_Leave
m


DrawingArea_GotFocus
m


DrawingArea_LostFocus
m


DrawingArea_MouseDown
m


DrawingArea_MouseUp
m


Timer_Timer
m


DrawingArea_MouseWheel
m


DrawingArea_KeyPress
m


#TabPanel
UserContainer
C
_Properties
C
s
"*,Border=True,Count{Range:1;256}=1,Index,Text,TextFont,Picture,Orientation{Align.Top;Bottom}=Top,Closable,CloseButton,Moveable,Highlight,ShowTabBar=True"
_Similar
C
s
"TabStrip"
_IsMultiContainer
C
b
T
_DefaultEvent
C
s
"Click"
:Click
:


:Close
:

(Index)i
Index
p
i

:Move
:

(Source)i(Target)i
:CloseAll
:


:Select
:


'@{since 3.20}
'
'This event is raised when a tab button is clicked, even if it is the current one.
Count
p
i

Text
p
s

Picture
p
Picture

Font
p
Font

TextFont
p
Font

Border
p
b

Orientation
p
i

Highlight
p
b

Closable
p
b

Current
r
_TabPanelContainer

Background
p
i

Moveable
p
b

CloseButton
p
b

TabBarSize
r
i

TabBarPaddingStart
p
i

TabBarPaddingEnd
p
i

ShowTabBar
p
b

'Return or set if the tab bar is displayed.
_new
m


_EnsureCurrentVisible
m


EnsureCurrentVisible_Timer
m


TabBar_Arrange
m


Arrow_Enter
m


Arrow_Leave
m


Arrow_Draw
m


Arrow_MouseDown
m


Arrow_MouseUp
m


Arrow_DblClick
m


TimerRepeat_Timer
m


Remove
m

(Index)i
_get
m
_TabPanelContainer
(Index)i
_GetIndex
m
i
(hCont)Control;
_GetButton
m
_TabPanelButton
(iIndex)i
Panel_Draw
m


Panel_Arrange
m


_SetVisible
m

(Index)i(bVisible)b
_MoveNext
m


_MovePrevious
m


_IsVisible
m
b
(Index)i
_GetFirstIndex
m
i

_Close
m

(Index)i
_GetBackground
m
i

TabBarContainer_KeyPress
m


_MoveTab
m

(hSrc)_TabPanelButton;(hDst)_TabPanelButton;(bAfter)b
TabPanel_Arrange
m


ClosePanel_Draw
m


CloseAll_Click
m


FindPanel
m
i
(Text)s
'Return the index of the first panel having a specific title.
'
'- ~Text~ : panel title to search for.
'
''-1' is returned if no panel is found.
_RaiseSelect
m


#TableView
GridView
C
_Properties
C
s
"*,NoKeyboard"
_Group
C
s
"View"
_Similar
C
s
"GridView"
:Save
:

(Row)i(Column)i(Value)s
:Insert
:


:Click
:


:Hide
:


Editor
r
Control

NoKeyboard
p
b

_new
m


Save
m
b

Cancel
m


GridView_MouseDown
m


GridView_RowResize
m

(Row)i
GridView_ColumnResize
m

(Column)i
GridView_Scroll
m


GridView_Arrange
m


Watcher_Resize
m


Watcher_Hide
m


GridView_Change
m


Edit
m

[(List)String[];(ReadOnly)b]
EditWith
m

(Editor)Control;
Editor_Activate
m


Editor_Click
m


Editor_KeyPress
m


Timer_Timer
m


Clear
m


_GetPreferredWidth
m
i
(iCol)i
#TimeBox
UserControl
C
_Properties
C
s
"*,Action,Value,ReadOnly,Border=True,ShowHour=True,ShowSecond=True"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"TextBox"
Value
p
d

ReadOnly
p
b

Border
p
b

ShowHour
p
b

ShowSecond
p
b

'@{since 3.20}
'
'Return or set if the second field is visible.
_new
m


HourBox_GotFocus
m


MinuteBox_GotFocus
m


SecondBox_GotFocus
m


HourBox_LostFocus
m


MinuteBox_LostFocus
m


SecondBox_LostFocus
m


SecondBox_Limit
m


MinuteBox_Limit
m


Border_Draw
m


Label_Draw
m


#ToolPanel
UserContainer
C
_Properties
C
s
"*,Count{Range:1;256}=1,Index,Text,TextFont,Picture,Animated,Border"
_Similar
C
s
"TabStrip"
_IsMultiContainer
C
b
T
_DefaultText
C
s
"Toolbar &1"
:Click
:


Count
p
i

Index
p
i

Text
p
s

Picture
p
Picture

Animated
p
b

Font
p
Font

TextFont
p
Font

Border
p
b

_new
m


Animate_Timer
m


ToolPanelContainer__Change
m


ToolPanel_Resize
m


_get
m
_ToolPanelContainer
(Index)i
FindPanel
m
i
(Text)s
'Return the index of the first panel having a specific title.
'
'- ~Text~ : panel title to search for.
'
''-1' is returned if no panel is found.
#URLLabel
Label
C
_Properties
C
s
"*,Link"
_DefaultEvent
C
s
"Click"
:Click
:


Link
p
s

Visited
p
b

Foreground
p
i

Text
p
s

_new
m


Label_Enter
m


Label_Leave
m


Label_MouseDown
m


#ValueBox
UserControl
C
_Properties
C
s
"*,Action,Text,Alignment{Align.Normal;Left;Center;Right}=Normal,Type{ValueBox.*}=Number,ReadOnly,Border=True"
_DefaultSize
C
s
"24,4"
_Similar
C
s
"TextBox"
:Change
:


Type
p
i

Value
p
v

Border
p
b

ReadOnly
p
b

Text
p
s

Alignment
p
i

Number
C
i
0
Date
C
i
1
Time
C
i
2
Currency
C
i
3
DateTime
C
i
4
IPAddress
C
i
5
_new
m


NumberBox_KeyPress
m


NumberBox_Change
m


DateBox_Change
m


CurrencyBox_Change
m


IpAddressBox_Change
m


SelectAll
m


'Select all the editor contents.
Unselect
m


'@{since 3.19}
'
'Unselect the editor contents.
#Wizard
UserContainer
C
_Properties
C
s
"*,Count{Range:1;256}=1,Index,Text,TextFont,Picture,ShowTitle=True,ShowIndex=False,ShowButton=True,Border=True,ActionText,ActionPicture"
_DefaultEvent
C
s
"Change"
_Similar
C
s
"TabStrip"
_IsMultiContainer
C
b
T
:BeforeChange
:


:Change
:


:Cancel
:


:Click
:


:Close
:


Count
p
i

Index
p
i

LastIndex
r
i

Text
p
s

Picture
p
Picture

ShowTitle
p
b

ShowIndex
p
b

Border
p
b

TextFont
p
Font

ActionText
p
s

ActionPicture
p
Picture

Animated
p
b

ShowButton
p
b

_new
m


Update
m


WizardContainer__Refresh
m


_get
m
_WizardContainer
(Index)i
Wizard_Previous
m


MovePrevious
m


Wizard_Next
m


MoveNext
m


Wizard_Cancel
m


FindPanel
m
i
(Text)s
'Return the index of the first wizard step having a specific title.
'
'- ~Text~ : wizard step title to search for.
'
''-1' is returned if no wizard step matches.
#_DateChooser_Colors

CA
_Calendar
v
FCalendar

Clear
m


_put
m

(Color)i(Date)d
_get
m
i
(Date)d
#_DateChooser_Data

C
Foreground
v
i

Background
v
i

Text
v
s

Font
p
Font

#_DateChooser_Date

C
Background
p
i

Foreground
p
i

Text
p
s

Font
p
Font

_Date
v
d

_View
v
DateChooser

#_DocumentItem

C
'This virtual class represents a specific page of the preview.
Height
r
i

'Return the page height in pixels.
H
r
i

'Return the page height in pixels.
Width
r
i

'Return the page width in pixels.
W
r
i

'Return the page width in pixels.
_Index
v
i

:_Foo
:


EnsureVisible
m


'Ensure that the page is visible.
IsVisible
m
b

'Return if a page preview is visible on the screen.
#_DocumentLayout

C
'This virtual class allows to define the layout of a specific page
Width
v
i

'Return or set the width of the page in millimiters.
Height
v
i

'Return or set the height of the page in millimiters.
#_FilePropertiesData

C
Type
v
s

Icon
v
Picture

#_IconPanelContainer
UserControl
C
Text
p
s

RichText
p
s

'Return or set the title of the icon panel as rich text.
Picture
p
Picture

Container
r
Container

Visible
p
b

_new
m


#_TabPanelContainer
UserControl
C
Text
p
s

RichText
p
s

Picture
p
Picture

Visible
p
b

Closable
p
b

_new
m


_Delete
m


Delete
m


#_ToolPanelContainer
UserControl
C
'This virtual class represents a [../toolpanel] tab.
:_Change
:


Text
p
s

'Return or set the tab title.
TextFont
p
Font

'Return or set if the font of the tab title.
'
'If this property is 'NULL' (the default), then the font of the ToolPanel control is used.
Picture
p
Picture

'Return or set the tab icon.
Visible
p
b

'Return or set if the tab is visible.
Container
r
Container

'Return the actual internal container of the tab.
_new
m


_GetButtonHeight
m
i

_Change
m


#_WizardContainer
UserControl
C
:_Refresh
:


Text
p
s

Picture
p
Picture

Container
r
Container

_new
m


