Gambas Documentation
Application Repository
Code Snippets
Compilation & Installation
Components
gb
gb.args
gb.cairo
gb.chart
gb.clipper
gb.complex
gb.compress
gb.crypt
gb.data
gb.db
gb.db.form
gb.db.mysql
gb.db.odbc
gb.db.postgresql
gb.db.sqlite2
gb.db.sqlite3
gb.dbus
gb.dbus.trayicon
gb.debug
gb.desktop
gb.desktop.gnome.keyring
gb.desktop.x11
gb.eval
gb.eval.highlight
gb.form
gb.form.dialog
gb.form.editor
gb.form.htmlview
gb.form.mdi
gb.form.print
gb.form.stock
gb.form.terminal
gb.gmp
gb.gsl
gb.gtk
gb.gtk.opengl
gb.gtk3
gb.gtk3.opengl
gb.gtk3.webview
gb.gui
gb.gui.opengl
gb.gui.qt
gb.gui.qt.ext
gb.gui.qt.opengl
gb.gui.qt.webkit
gb.gui.trayicon
gb.gui.webview
gb.hash
gb.highlight
gb.image
gb.image.effect
gb.image.imlib
gb.image.io
gb.inotify
gb.jit
gb.libxml
gb.logging
gb.map
gb.markdown
gb.media
gb.media.form
gb.memcached
gb.mime
gb.mongodb
gb.mysql
gb.ncurses
gb.net
gb.net.curl
gb.net.pop3
gb.net.smtp
gb.openal
gb.opengl
gb.opengl.glsl
gb.opengl.glu
gb.opengl.sge
gb.openssl
gb.option
gb.pcre
gb.pdf
gb.poppler
gb.qt4
gb.qt4.ext
gb.qt4.opengl
gb.qt4.webkit
gb.qt4.webview
gb.qt5
gb.qt5.ext
gb.qt5.opengl
gb.qt5.webkit
gb.qt5.webview
gb.qt6
gb.qt6.ext
gb.qt6.opengl
gb.qt6.webview
gb.report
gb.report2
gb.scanner
gb.sdl
gb.sdl.sound
gb.sdl2
gb.sdl2.audio
gb.settings
gb.signal
gb.term
gb.test
gb.util
gb.util.web
gb.v4l
gb.vb
gb.web
gb.web.feed
gb.web.form
gb.web.gui
gb.xml
gb.xml.html
gb.xml.rpc
gb.xml.xslt
Controls pictures
Deprecated components
Developer Documentation
Development Environment Documentation
Documents
Error Messages
Gambas Playground
How To's
Language Index
Language Overviews
Last Changes
Lexicon
README
Search the wiki
To Do
Topics
Tutorials
Wiki License
Wiki Manual

ListView (gb.gui.base)

This class inherits _TreeView in gb.qt4.

This class is creatable.

This class acts like a read-only array.

Inherited properties
Action   Returns or sets the action string associated with the control.
Available   Returns if the Item property is valid.
Background   Returns or sets the background color used by the control.
Border   Returns or sets if the control has a border.
Children   Returns a collection of each control included in the container.
ClientH   A synonymous for the ClientHeight property.
ClientHeight   Returns the height of the internal area containing the items.
ClientW   A synonymous for the ClientWidth property.
ClientWidth   Returns the width of the internal area containing the items.
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.
Compare   Use this property to return the result of the comparison of a Compare event.
Count   Returns the number of items in the view.
Current   Returns the current item, i.e. the item that has the focus, or that is selected in single selection mode.
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.
Editable   Returns if the items are editables by default, i.e. if they can be renamed by the user when he clicks on them.
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.
Highlight   Return or set if the item under the mouse cursor is highlighted.
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.
Indent   Return the size of tree indentation in pixels.
Item   Returns the item pointed by the internal cursor, or NULL if the internal cursor is not available.
Key   Returns the key of the Current item.
Keys   Return a list of all items keys
Left   Returns or sets the position of the left border of the control relative to its parent.
Mode   Returns or sets the selection mode.
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.
ProxyFor   Return which control that control is a proxy for.
Renaming   Return if an item is being renamed.
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.
ScrollBar   Returns or sets which scrollbars are displayed.
ScrollH   A synonymous of ScrollHeight.
ScrollHeight   Returns the contents height.
ScrollW   A synonymous of ScrollWidth.
ScrollWidth   Returns the contents width.
ScrollX   Returns or sets the horizontal scrolling position.
ScrollY   Returns or sets the vertical scrolling position.
Selected   Return if at least one item is selected.
Selection   Return the keys of all selected rows as a string array.
ShowCheck   Return or set if selection is indicated by check boxes and radio buttons, or by highlighting the items.
Sorted   Indicates if the items are sorted.
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
Add  

Inherited methods
Clear   Clears the view.
CollapseAll   Collapse all tree items recursively.
Delete   Destroys the control.
Drag   Starts a drag & drop process.
Exist   Returns if an item is associated with the given key.
ExpandAll   Expand all tree items recursively.
Filter   Filter the items according to the Filter event.
FindAt   Finds an item from coordinates relative to the control.
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.
MoveAbove   Moves the internal cursor one visible item above.
MoveBack   When one of the other Move* methods has failed, you can use this one to move the internal cursor back to its position before the move.
MoveBelow   Moves the internal cursor one visible item below.
MoveChild   Moves the internal cursor to the first child item.
MoveCurrent   Moves the internal cursor to the current item.
MoveFirst   Moves the internal cursor to the first item of the view.
MoveLast   Moves the internal cursor to the last item of the view.
MoveNext   Moves the internal cursor to the next child item.
MoveParent   Moves the internal cursor to the parent item.
MovePrevious   Moves the internal cursor to the previous sibling item.
MoveScaled   Moves and/or resizes the control.
MoveTo   Moves the internal cursor to a specified item.
Raise   Sends the control to the foreground of its parent.
Refresh   Trigger a redraw of the control.
Remove   Removes an item from the view.
Reparent   Changes the container of a control.
Resize   Resizes the control.
ResizeScaled   Resizes the control.
Scroll   Scroll the contents to the given position.
SelectAll   Select all items in the view.
SetFocus   Gives the focus to the control.
Show   Shows the control.
UnSelectAll   Unselect all selected items.

Inherited events
Activate   Raised when an item is double-clicked.
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.
BeforeSort   This event is raised before automatically sorting the items
Cancel   This event is raised when the user has canceled an in-place item renaming.
Click   Raised when an item is clicked.
Collapse   Raised when an item is collapsed.
Compare   This event is raised when two items must be compared.
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.
Draw   This event allows to customize the drawing of a specific item.
Drop   This event is raised when a drag is dropped in the control.
Enter   Raised when the mouse enters the control.
Expand   Raised when an item is expanded.
Filter   This event is raised to filter a specific item.
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.
Rename   Raised when the user has just renamed an item.
Scroll   This event is raised when the view scrolls.
Select   Raised when the selection of the view has changed.