Concept Framework 1.0 documentation Contents | Index

RTreeView

Name Version Deprecated
RTreeView version 1.0 no

Defined in : RTreeView.con
(this file must be included in your application in order to have access, unless you use a child class of RTreeView that includes this file)

Inherits : RemoteContainer  

Description:
The RTreeView control displays items organized in a hierarchical order. This control can show items (one or more columns) in a tree structure, or in a list structure depending on the chosen model (MODEL_TREEVIEW or MODEL_LISTVIEW).

A RTreeView item can be a number, text, image, check/radio box, progress bar, combo box, or any combination of these.


Properties:
ColumnIndex Sets or gets the index of the current selected column
Columns Provides access to the columns of the tree view, enabling you to modify properties like behavior, caption, size by using the RTreeViewColumnManager
EnableSearch Enables the user to start an interactive search by typing in the text
Expand This function will expand the tree making the item on indicated by the path parameter visible
ExpanderColumn Sets or gets the index of the column that is the current expander column
FixedHeightMode When this property is set to true, all the rows in the tree view have the same height
HAdjustment An instance to a RAdjustment for controlling the horizontal adjustment of the tree view
HeadersVisible If true (default) the tree view column headers are visible; if set to false, are hidden (the tree view displaying only the items
HoverExpand Hover expansion makes rows expand or collapse if the pointer moves over them
HoverSelection Hover selection makes the selected row follow the pointer if set to true
Items Represents the items kept by the RTreeView
Model Sets the model used by the tree view
Reorderable If Reorderable is true, then the user can reorder the model by dragging and dropping rows
RowIndex Returns the index or the path of the current selected item
RulesHint This property tells GTK+ client that the user interface for your application requires users to read across tree rows and associate cells with one another
SearchColumn Sets or gets the column index of the column where the interactive search code should search in
SortColumn Sets or gets the column used in the sort process
SortDescending If this property is set to true, then the items in the view will be set in a reverse order (descending)
Sorted Set to true if the items added into the RTreeView are sorted
VAdjustment An instance to a RAdjustment for controlling the vertical adjustment of the tree view

Methods:
AddChild Adds a child to the tree node specified
AddColumn This function will add columns to a view
AddItem This function adds an item in the view
AlternateColors Set the odd and even row background color
Clear Clears all the rows in the view
ClearColumns Clears all the columns in the view
Collapse This function will collapse the tree making the item on indicated by the path parameter collapsed (if possible)
CollapseAll This function will collapse all the tree nodes
CreateDragIconFromCurrent This will create a remote image that will appear when this control will be dragged
DeleteItem Deletes the item in the view at the given index
ExpandAll This function will expand all the tree nodes
ExpandToPath This function will expand row at path
InsertChild Inserts a child to the tree node specified by path_after at the index specified by the index parameter
InsertItem This function inserts an item at the given position
PathToStr Converts an array of the form [1,2,3] to an equivalent string like "1:2:3"
RTreeView This is the standard contructor for this class and should not be used directly
RemoveColumn Removes a column by its index
ScrollToColumn This function will scroll (horizontally) the view to ensuring that the column indicated by the index parameter is visible
ScrollToRow This function will scroll (vertically) the view to the position indicated by the path parameter
UpdateItem This function updates an item at the given position

Events:
OnCancelEditing Event fired when the user cancels the edit process of an editable cell, for example by pressing the escape key
OnColumnsChanged This event is fired when the columns configuration changes
OnCursorChanged This event is fired when the cursor position changes
OnEndEditing Event fired when the user successfully ends the editing process of an editable column
OnHeadersClicked Event fired when the user click on the treeview header (when {HeadersClickable} is set to true)
OnRowActivated This event is fired when a row is activated (user double clicks it for example)
OnRowCollapsed This event is fired when a row is collapsed
OnRowExpanded This event is fired when a row is expanded
OnSetScrollAdjustments This event is fired when the scroll adjustments are set
OnStartEditing Event fired when the user starts the editing process of an editable column

Inherited from RemoteContainer:

Inherited properties from RemoteContainer
Childs An array containing the children of an RemoteContainer-derived object

Inherited methods from RemoteContainer
Add This member adds a child to the container

Inherited from VisibleRemoteObject:

Inherited properties from VisibleRemoteObject
BgColor This property sets or gets the background color of a control
DragData This is the data received by the control on which this control is dropped OnDragDataReceived
Dragable When this property is set to true, a control can be dragged by the user (using the mouse)
DropSite When this property is set to true, a control can receive Dragable objects
Enabled When this property is set to true, a control can receive focus (is enabled)
FgColor This property sets or gets the foreground color of a control
Font Allows to modify the font used by a control via the RFont class
Height This property gets the height (in pixels) of a control
InactiveBgColor This property sets or gets the background color of an inactive object
InactiveFgColor This property sets or gets the foreground color of an inactive object
Left This property gets the number of pixels from the left margin of this control to the left margin of its parent
MinHeight This property gets or sets the minimum height(in pixels) for a control
MinWidth This property gets or sets the minimum width for a control
MouseCursor This property sets or gets the mouse cursor image using a stock image
MouseCursorImage This property sets the image used by the mouse cursor from a RImage object
PackType This property sets or gets the type of the packing used for the next child of this control
Packing This property sets or gets the type of the packing for this control
PopupMenu This property gets or sets the popup menu used for this control (the menu that appears when the mouse is right clicked)
SelectedBgColor This property sets or gets the background color of a selected control
SelectedFgColor This property sets or gets the foreground color of a selected control
Tooltip This property sets or gets the tool tip for a visible object
Top This property gets the number of pixels from the top margin of this control to the top margin of its parent
UserData This is a property that encapsulates custom data that needs to be attached to a control
Visible A Boolean value specifying whether the button is visible
Width This property gets the width (in pixels) of a control

Inherited methods from VisibleRemoteObject
ConfirmDelete This function is used to confirm the Delete event in an OnDelete event that needs confirmation
ConfirmEvent Some events require confirmation
DisposeObject This function tells the client that a control is no longer needed and can be deleted
GrabFocus This function marks the control as focused
Hide This function hides this control by setting the Visible property to false
Send Sends a message to the client
Show This function shows this control by setting the Visible property to true

Inherited events from VisibleRemoteObject
OnButtonPress Event triggered by user pressing button
OnButtonRelease Event triggered by user releasing button
OnChildNotify This event is fired for each child property that has changed on an object
OnConfigure Event triggered by a window resizing
OnDelete Event triggered by window begin closed
OnDirectionChanged Informs objects that their text direction has been changed (if the control contains text)
OnDragBegin This event is fired on the drag source when a drag is started
OnDragDataDelete This event is fired on the drag source when a drag with the move action is successfully completed
OnDragDataGet This event is fired on the drag source when the drop site requests the data which is dragged
OnDragDataReceived This event is fired on the drop site when the dragged data has been received
OnDragDrop The event is fired on the drop site when the user drops the data onto the control
OnDragEnd This event is fired on the drag source when a drag is finished
OnDragLeave This event is fired on the drop site when the cursor leaves the control
OnDragMotion The event is fired on the drop site when the user moves the cursor over the control during a drag
OnEnterNotify Generated when the pointer enters a window
OnEvent This event is fired when another event is fired
OnExposeEvent Event triggered by window requiring a refresh
OnFocus This event is fired when this control receives focus(check GTK documentation for more information)
OnFocusIn This event is fired when this control receives focus(check GTK documentation for more information)
OnFocusOut This event is fired when this control looses its focus(check GTK documentation for more information)
OnGrabFocus This event is fired when this control grabs focus
OnGrabNotify Event fired when a control is grabbed(check GTK for more information)
OnHide Event triggered when the control is hidden
OnHierarchyChanged Informs objects that their top level control has been changed
OnKeyPress This event is fired whenever the Sender control picks up a key pressed signal
OnKeyRelease This event is fired whenever the user releases a key
OnLeaveNotify Generated when the pointer leaves a window
OnMap Event triggered when the control is mapped (please check GTK documentation for more information)
OnMapEvent Event triggered when the control is raising a map_event signal (please check GTK documentation for more information)
OnMnemonicActivate Event fired when a mnemonic is activated(check GTK for more information)
OnMotionNotify Event triggered by user moving pointer
OnNoExpose Event triggered by window requiring a refresh
OnParentChanged This event is fired when the control's parent is changed
OnProperty Event triggered when a property of the control is changed(please check GTK documentation for more information)
OnProximityIn Proximity events are generated when using GDK's wrapper for the XInput extension
OnProximityOut Proximity events are generated when using GDK's wrapper for the XInput extension
OnRealize Event triggered when the control is realized (please check GTK documentation for more information)
OnScreenChanged This event is fired when the screen is changed(check GTK documentation for more information)
OnScroll Generated from button presses for the buttons 4 to 7
OnSelectionClear Generated when a selection is requested or ownership of a selection is taken over by another client application
OnSelectionGet The "selection-get" event is fired when the selection data is requested from control(see gtk documentation for more information)
OnSelectionNotify Generated when a selection is requested or ownership of a selection is taken over by another client application
OnSelectionReceived This event is fired when the selection data is received from control(see gtk documentation for more information)
OnSelectionRequest Generated when a selection is requested or ownership of a selection is taken over by another client application
OnShow Event triggered when the control is shown
OnSizeAllocate Event triggered after the control is resized (please check GTK documentation for more information)
OnSizeRequest Event triggered before the control is resized (please check GTK documentation for more information)
OnStateChanged Event triggered when the control's state is changed(please check GTK documentation for more information)
OnStyleChanged Informs objects that their style has been changed
OnUnmap Event triggered when the control is mapped (please check GTK documentation for more information)
OnUnmapEvent Event triggered when the control is raising a unmap_event signal (please check GTK documentation for more information)
OnUnrealize Event triggered when the control is unrealized (please check GTK documentation for more information)
OnVisibility This event is fired whenever the Sender control visibility is changed
OnWindowState This event is generated when the state of a toplevel window changes

Inherited from RemoteObject:

Inherited properties from RemoteObject
Parent This function returns the Parent for a specific Concept GUI Object
RID The RID (Remote ID) for an object

Inherited methods from RemoteObject
AddTimer This function sets up a timer
GetObjectByID This function finds the object corresponding to the ID parameter
LinkIfNotLinked This is a special function, wich should be used after a GUI object was created that has no parent
Repaint This member tells to the remote control to repaint itself(Queue for redraw)




Valid HTML 4.0 Transitional Valid CSS!

Documented by Eduard Suica, generation time: Thu Nov 15 09:05:11 2007 GMT(c)2007 RadGs Software