DrawingArea (gb.qt4)

This control implements an area that can be drawn by the application. It has two behaviors, standard and cached, defined by the Cached property.

  • In standard mode, The DrawingArea will raise the Draw event each time it needs to be refreshed.

  • In cached mode, The drawing is done once, by using the DrawingArea control as a drawing device. This drawing is stored inside an internal Picture that is used by the DrawingArea to refresh itself.

By default, the drawing must be done by using the Draw class. If you set the Painted property, the drawing will have to be done by the Paint class, and so will be anti-aliased.

Since 3.4

The Painted is useless and therefore deprecated since Gambas 3.4.

This class inherits Container.

This class is creatable.

Properties
Arrangement   Returns or sets how this container arrange its children controls.
AutoResize   Indicates that the container automatically resizes to the size of its contents.
Background   Returns or sets the background color used by the control.
Border   Returns or sets the border type of the control.
Cached   Returns or sets if the DrawingArea contents are cached into a internal Picture object.
Centered   Center controls horizontally or vertically according to the container arrangement.
Enabled   Returns or sets if the drawing area is enabled.
Focus   Returns or sets if the control accepts keyboard events and focus.
Indent   Returns or sets if the children controls of the container are indented.
Invert   Return or set if the horizontal or vertical arrangement direction is inverted.
Margin   Returns or sets if there is a margin between the container border and all its children.
NoBackground   Return or set if the DrawingArea automatically draws its background.
NoMouse   Return or set if the control is transparent to mouse events.
Padding   Returns or sets the number of pixels used as space between children controls, or container inner margin.
Painted   Return or set if the Paint class must be used to draw on the DrawingArea instead of the Draw class.
Spacing   Returns or sets if the children of the container are spaced out.
Tablet   Return or set if the DrawingArea will receive tablet events as mouse events.

Inherited properties
Action   Returns or sets the action string associated with the control.
Children   Returns a collection of each control included in the container.
ClientH   A synonymous for the ClientHeight property.
ClientHeight   Returns the height of the area containing the controls.
ClientW   A synonymous for the ClientWidth property.
ClientWidth   Returns the width of the area containing the controls.
ClientX   Returns the position of the left border of the area containing the controls.
ClientY   Returns the position of the top border of the area containing the controls.
Cursor   Use this property for assigning a custom cursor to a control.
Design   Indicates that the control is in design mode.
Direction   Return or set the control text direction.
Drop   Returns or sets if a control accepts drops.
Expand   Returns or sets if a control will expand if included in a container that arranges its contents.
Font   Returns or sets the font used to draw text in the control.
Foreground   Returns or sets the foreground color used by the control.
H   A synonymous for the Height property.
Handle   Returns the internal X11 window handle of the control.
HasFocus   Returns whether the control has the focus.
Height   Returns or sets the height of the control.
Hovered   Returns whether the mouse cursor is inside the control.
Id   A synonymous for the Handle property.
Ignore   Returns or sets if a control must be ignored when its parent arranges its children.
Left   Returns or sets the position of the left border of the control relative to its parent.
Mouse   Returns or sets the appearence of the cursor when it points inside the control.
Name   Returns or sets the name of the control.
Next   Returns the next control having the same parent.
NoTabFocus   Return or set if a control cannot be focused with the TAB key.
Parent   Returns the control container.
PopupMenu   Return or set the name of the menu that will be popped-up when the user presses the right mouse button or the keyboard MENU key.
Previous   Returns the previous control having the same parent.
Proxy   Return or set the "proxy" of a control.
RightToLeft   Return if the control is right to left oriented.
ScreenX   Returns the position of the left border of the control in screen coordinates.
ScreenY   Returns the position of the top border of the control in screen coordinates.
Tag   Returns or sets the control tag.
Tooltip   Returns or sets the tooltip shown when the mouse stays on the control for a short time.
Top   Returns or sets the position of the top border of the control relative to its parent.
Tracking   Returns or sets if the control will receive MouseMove events.
Visible   Indicates if the control is visible or not.
W   A synonymous for the Width property.
Width   Returns or sets the width of the control.
Window   Returns the top-level window that contains the control.
X   Returns or sets the position of the left border of the control relative to its parent.
Y   Returns or sets the position of the top border of the control relative to its parent.

Methods
Clear   Clears the drawing area.
Refresh   Trigger a redraw of the control.

Inherited methods
Delete   Destroys the control.
Drag   Starts a drag & drop process.
FindChild   Finds the first child control pointed by the X and Y coordinates.
Grab   Grab the keyboard and the mouse so that all keyboard and mouse events are received by the control.
Hide   Hides the control.
Lower   Sends the control to the background of its parent.
Move   Moves and/or resizes the control.
MoveScaled   Moves and/or resizes the control.
Raise   Sends the control to the foreground of its parent.
Reparent   Changes the container of a control.
Resize   Resizes the control.
ResizeScaled   Resizes the control.
SetFocus   Gives the focus to the control.
Show   Shows the control.

Events
Change   This event is raised when one of the following properties has been modified:
Draw   Raised when something must be redrawn.
Font   This event is raised when the DrawingArea font has changed for any reason.

Inherited events
Arrange   This event is raised when a container has just finished arranging its contents.
BeforeArrange   This event is raised just before a container arranges its contents.
DblClick   Raised when the user quickly clicks twice on the control.
Drag   This event is raised when the mouse enters the control during a drag & drop process.
DragLeave   This event is raised when the mouse leaves the control during a drag & drop operation.
DragMove   This event is raised while the mouse moves inside the control during a drag & drop process.
Drop   This event is raised when a drag is dropped in the control.
Enter   Raised when the mouse enters the control.
GotFocus   Raised when the control has got the focus.
KeyPress   Raised when a key is pressed while the control has the focus.
KeyRelease   Raised when a key is released while the control has the focus.
Leave   Raised when the mouse leaves the control.
LostFocus   Raised when the control has lost the focus.
Menu   Raised when the user clicks on the control with the right mouse button, or if it hits the MENU key.
MouseDown   Raised when a mouse button is pressed while the cursor is inside the control.
MouseDrag   This event is raised when a drag operation should be started.
MouseMove   Raised when the mouse moves inside the control while a mouse button is pressed.
MouseUp   Raised when a mouse button is depressed while the cursor is inside the control.
MouseWheel   This event is raised when the user moves or presses the mouse wheel while the mouse is inside the control.
NewChild   This event is raised when a new child Control has just been inserted into the container.

See also