comp • gb.form • documentview

DocumentView (gb.form)

This control is a document viewer.

It allow to display multiple document pages with different sizes or not, using many different arrangements.

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

Constants

Paysage   Portrait  

Properties

Methods Events
Returns or sets the action string associated with the control.
Action  
Return or set the pages arrangement.
Arrangement  
Return or set if the page is centered in the case where only one page is displayed in width.
AutoCenter  
Returns or sets the background color used by the control.
Background  
Border  
Returns a collection of each control included in the container.
Children  
A synonymous for the ClientHeight property.
ClientH  
Returns the height of the area containing the controls.
ClientHeight  
A synonymous for the ClientWidth property.
ClientW  
Returns the width of the area containing the controls.
ClientWidth  
Returns the position of the top border of the area containing the controls.
ClientX  
Returns the position of the left border of the area containing the controls.
ClientY  
It allow to fix the number of columns or rows displayed depend of the arrangement mode selected.
Column  
Return or set the number of displayed pages.
Count  
Use this property for assigning a custom cursor to a control.
Cursor  
Indicates that the control is in design mode.
Design  
Returns or sets the global document height.
DocHeight  
Returns or sets the global document width.
DocWidth  
Returns or sets if a control accepts drops.
Drop  
Indicates that the control is enabled.
Enabled  
Returns or sets if a control will expand if included in a container that arranges its contents.
Expand  
Return the number of the first visible page in the viewer.
FirstVisibleDocument  
Returns or sets the font used to draw text in the control.
Font  
Returns or sets the foreground color used by the control.
Foreground  
A synonymous for the Height property.
H  
Returns the internal X11 window handle of the control.
Handle  
Returns whether the control has the focus.
HasFocus  
Returns or sets the height of the control.
Height  
Returns whether the mouse cursor is inside the control.
Hovered  
A synonymous for the Handle property.
Id  
Returns or sets if a control must be ignored when its parent arranges its children.
Ignore  
Item  
Return the number of the last visible page in the viewer.
LastVisibleDocument  
This property is used to set the width/height of the page during the Layout event.
Layout  
Returns or sets the position of the left border of the control relative to its parent.
Left  
Max  
Returns or sets the appearence of the cursor when it points inside the control.
Mouse  
Returns or sets the name of the control.
Name  
Returns the next control having the same parent.
Next  
Return or set if a control cannot be focused with the TAB key.
NoTabFocus  
Padding  
Return or set the default page height.
PageHeight  
Return or set the default page width.
PageWidth  
Returns the control container.
Parent  
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.
PopupMenu  
Returns the previous control having the same parent.
Previous  
Return or set the "proxy" of a control.
Proxy  
Row   Scale  
Returns the position of the left border of the control in screen coordinates.
ScreenX  
Returns the position of the top border of the control in screen coordinates.
ScreenY  
Return or set if the document shadow is displayed.
ShowShadow  
Spacing  
Returns or sets the control tag.
Tag  
Returns or sets the tooltip shown when the mouse stays on the control for a short time.
Tooltip  
Returns or sets the position of the top border of the control relative to its parent.
Top  
Returns or sets if the control will receive MouseMove events.
Tracking  
Indicates if the control is visible or not.
Visible  
A synonymous for the Width property.
W  
Returns or sets the width of the control.
Width  
Returns the top-level window that contains the control.
Window  
Returns or sets the position of the left border of the control relative to its parent.
X  
Returns or sets the position of the top border of the control relative to its parent.
Y  
Zoom  
Destroys the control.
Delete  
Starts a drag & drop process.
Drag  
Find  
Finds the first child control pointed by the X and Y coordinates.
FindChild  
Goto  
Grab the keyboard and the mouse so that all keyboard and mouse events are received by the control.
Grab  
Hides the control.
Hide  
Sends the control to the background of its parent.
Lower  
Moves and/or resizes the control.
Move  
MoveFirst   MoveNext   MovePrevious  
Moves and/or resizes the control.
MoveScaled  
MoveTo  
Sends the control to the foreground of its parent.
Raise  
Refresh  
Changes the container of a control.
Reparent  
Reset  
Resizes the control.
Resize  
Resizes the control.
ResizeScaled  
Gives the focus to the control.
SetFocus  
Shows the control.
Show  
This event is raised when a container has just finished arranging its contents.
Arrange  
This event is raised just before a container arranges its contents.
BeforeArrange  
Raised when the user quickly clicks twice on the control.
DblClick  
This event is raised when the mouse enters the control during a drag & drop process.
Drag  
This event is raised when the mouse leaves the control during a drag & drop operation.
DragLeave  
This event is raised while the mouse moves inside the control during a drag & drop process.
DragMove  
Draw  
This event is raised when a drag is dropped in the control.
Drop  
Raised when the mouse enters the control.
Enter  
Finished  
Raised when the control has got the focus.
GotFocus  
Raised when a key is pressed while the control has the focus.
KeyPress  
Raised when a key is released while the control has the focus.
KeyRelease  
Layout  
Raised when the mouse leaves the control.
Leave  
Raised when the control has lost the focus.
LostFocus  
Raised when the user clicks on the control with the right mouse button, or if it hits the MENU key.
Menu  
Raised when a mouse button is pressed while the cursor is inside the control.
MouseDown  
This event is raised when a drag operation should be started.
MouseDrag  
Raised when the mouse moves inside the control while a mouse button is pressed.
MouseMove  
Raised when a mouse button is depressed while the cursor is inside the control.
MouseUp  
This event is raised when the user moves or presses the mouse wheel while the mouse is inside the control.
MouseWheel  
This event is raised when a new child Control has just been inserted into the container.
NewChild  
Zoom