DocumentView (gb.form)

This control implements a paged document viewer.

This class inherits UserControl in gb.qt4. This class is creatable . This class acts like a read-only array.

Properties

Arrangement Return or set how the different pages are arranged inside the view.

AutoCenter Return or set if the page is centered in the case where only one page is displayed in width.

Border Return or set if the document view has a border.

Center Return or set if the page must be centered in the view.

Column It allow to fix the number of columns or rows displayed depend of the arrangement mode selected.

Columns Return or set the number of columns used for layouting pages.

Count Return or set the number of pages in the document.

Desaturate Return or set if the preview is automatically desaturated.

DocHeight Return or set the default height of a page in millimiters.

DocWidth Return or set the default width of a page in millimiters.

FirstVisibleDocument Return the number of the first visible page in the viewer.

FirstVisiblePage Return the index of the first visible page.

LastVisibleDocument Return the number of the last visible page in the viewer.

LastVisiblePage Return the index of the last visible page.

Layout Return a virtual object used for defining the layout of a specific page.

Max Return the number of pages in the document minus one.

Padding Return or set the padding inside the view in millimiters.

PageHeight Return or set the default height of a page in millimiters.

PageWidth Return or set the default width of a page in millimiters.

Scale Return or set the zoom factor of the view.

ShowPage Return or set if the page number must be displayed inside the view.

ShowShadow Return or set if pages are drawn with a little shadow.

Spacing Return or set the spacing between the different pages in millimiters.

Zoom Return or set the zoom factor of the view.

Inherited properties

Action Returns or sets the action string associated with the control.

Background Returns or sets the background color used by 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

Since 3.17

Return or set the control text direction.

Drop Returns or sets if a control accepts drops.

Enabled Indicates that the control is enabled.

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.

NoAnimation

Since 3.20

Return or set if the possible animations of a control are disabled.

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.

ProxyFor Return which control that control is a proxy for.

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.

TopLevel

Since 3.21

Return the top-level window this control belongs to.

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

Find Return the page number under a specific mouse cursor position.

Goto Move the view to a specified page.

Refresh Refresh the view contents.

Reset Resets the view.

Inherited methods

Delete Destroys the control.

Drag Starts a drag & drop process.

FindChild

Since 3.4

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

Draw This event is raised when a specific page preview must me drawn

Finished This event is raised when all page preview have been drawn.

Layout This event is raised so that each page layout can be defined independently.

Zoom This event is raised when the zoom level has changed.

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.