CFxUITableView Class Reference

#include <FxUITableView.h>

Inheritance diagram for CFxUITableView:

Public Types
enum	UISelectionBehavior { SelectItems , SelectRows , SelectColumns }
enum	UISelectionMode {   NoSelection , SingleSelection , MultiSelection , ExtendedSelection ,   ContiguousSelection }
enum	UIHeaderResizeMode {   Interactive , Stretch , Fixed , ResizeToContents ,   Custom = Fixed }
enum	UISelectionFlag {   NoUpdate = 0x0000 , Clear = 0x0001 , Select = 0x0002 , Deselect = 0x0004 ,   Rows = 0x0020 , Columns = 0x0040 , ClearAndSelect = Clear | Select }
enum	UIMouseClickEvent { None = 0 , Left = 1 , Middle = 2 , Right = 4 }
Public Types inherited from CFxUIBaseView
enum	TextAlignment {   AlignLeft = 0x0001 , AlignRight = 0x0002 , AlignHCenter = 0x0004 , AlignJustify = 0x0008 ,   AlignTop = 0x0020 , AlignBottom = 0x0040 , AlignVCenter = 0x0080 , AlignBaseline = 0x0100 ,   AlignCenter = AlignVCenter | AlignHCenter }
enum	FocusPolicyType {   eNoFocus = 0 , eTabFocus = 0x1 , eClickFocus = 0x2 , eStrongFocus = eTabFocus | eClickFocus | 0x8 ,   eWheelFocus = eStrongFocus | 0x4 , eKeyboardOnSetfocus = 0x10 }
enum	UIWidthSizePolicy {   eExpanding = -1 , eXS = 0 , eS , eM ,   eL , eXL }
enum	UIScrollBarPolicy { eScrollBarAsNeeded = 0 , eScrollBarAlwaysOff , eScrollBarAlwaysOn }

Public Member Functions
	CFxUITableView ()
	~CFxUITableView ()
void	setHorizontalHeaderResizeSection (CFxUITableView::UIHeaderResizeMode mode, int iColumn)
void	setHorizontalHeaderStretchLastSection (bool bEnable)
void	setVerticalHeaderStretchLastSection (bool bEnable)
void	setHorizontalScrollBarPolicy (CFxUIBaseView::UIScrollBarPolicy mode)
void	setVerticalScrollBarPolicy (CFxUIBaseView::UIScrollBarPolicy mode)
void	setSortingEnabled (bool bEnable)
void	sortByColumn (int column, int order)
void	setSelectionBehavior (CFxUITableView::UISelectionBehavior behavior)
void	setSelectionMode (CFxUITableView::UISelectionMode mode)
void	setColumnWidth (int iColumn, int iWidth)
int	columnWidth (int iColumn) const
void	setModel (CFxUIAbstractItemModel *model)
CFxUIAbstractItemModel *	getModel ()
void	setCurrentIndex (CFxUIModelIndex index)
CFxUIModelIndex	currentIndex () const
void	clearSelection ()
std::vector< CFxUIModelIndex >	selectedIndexes () const
void	selectRow (CFxUITableView::UISelectionFlag flag, CFxUIModelIndex index)
void	setVerticalHeaderHidden (bool bHide)
void	setHorzHeaderHidden (bool bHide)
void	setHorzScrollBarDisable (bool bDisable)
void	setColumnHidden (int iColumn, bool bHide)
void	openPersistentEditor (const CFxUIModelIndex &index)
CFxUISignal< void(const CFxUIModelIndex &)> &	itemClicked ()
CFxUISignal< void(CFxUIModelIndex, CFxUITableView::UIMouseClickEvent)> &	mouseClicked ()
CFxUISignal< void(void)> &	selectionChanged ()
void	setShowGrid (bool visible, int mask=CFxUIModelIndex::Horizontal|CFxUIModelIndex::Vertical)
bool	showGrid ()
Public Member Functions inherited from CFxUIBaseView
	CFxUIBaseView ()
virtual	~CFxUIBaseView ()
void	setDisabled (bool on)
void	setEnabled (bool on)
bool	isEnabled () const
CFxUIPalette::FxUIColorRole	backgroundRole ()
void	setPalette (const CFxUIPalette &)
const CFxUIPalette &	palette () const
bool	isVisible ()
void	setVisible (bool bVisible)
bool	isHidden ()
void	setHidden (bool bHidden)
bool	hasFocus () const
void	setFocus ()
void	setFocus (int iReason)
void	setFocusPolicy (int iPolicy)
int	width ()
void	setWidth (int w)
int	height ()
void	setHeight (int h)
void	update ()
void	setBusyState (bool bBusy=false)
void	resize (int w, int h)
void	setCornerRadius (float radius)
void	setBorderWidth (float width)
void	setBorderWidth (float left, float top, float right, float bottom)
void	setBorderColor (int r, int g, int b)
virtual void	showEvent (CFxUIShowEvent *event)
virtual void	hideEvent (CFxUIHideEvent *event)
virtual void	paintEvent (CFxUIPaintEvent *event)
virtual void	resizeEvent (CFxUIResizeEvent *event)
virtual void	focusInEvent (CFxUIFocusEvent *focusInEvent)
virtual void	focusOutEvent (CFxUIFocusEvent *focusOutEvent)
virtual void	mousePressEvent (CFxUIMouseEvent *mouseEvent)
void	setEventAccepted (bool bAccepted=false)
void	setEventRejected (bool bRejected=false)
void	addView (CFxUIBaseView *pChild, float fWeight=0.0)
void	insertView (CFxUIBaseView *pChild, int index=0, float fWeight=0.0)
int	indexOf (CFxUIBaseView *pChild)
void	removeView (CFxUIBaseView *pChild)
void	setPreferableSize (int w, int h)
void	setMinimumWidth (int iWidth)
void	setMinimumHeight (int iHeight)
void	setMinimumSize (const CFxUISize &size)
void	setMaximumWidth (int iWidth)
void	setMaximumHeight (int iHeight)
void	setMaximumSize (const CFxUISize &size)
int	minimumWidth ()
int	minimumHeight ()
int	maximumWidth ()
int	maximumHeight ()
void	setToolTip (const CFxUIString &sToolTip)
const CFxUIString	toolTip ()
bool	underMouse ()
void	setMask (const CFxUIRegion &region)
void	move (const CFxUIPoint &pos)
CFxUISize	sizeHint () const
CFxUIPoint	mapToGlobal (const CFxUIPoint &pos)
void	setMargin (int left, int top, int right, int bottom)
void	setParentWidget (CFxUIBaseView *pParent)
float	getViewOpacity () const
void	setViewOpacity (const float &opacity)
CFxUISignal< void(void)> &	aboutToPassEventToParent ()
CFxUISignal< void(void)> &	aboutToShow ()
CFxUISignal< void(void)> &	hoverEnter ()
CFxUISignal< void(void)> &	hoverLeave ()
CFxUISignal< void(bool)> &	visibilityChanged ()
Public Member Functions inherited from CFxUIObject
	CFxUIObject ()
virtual	~CFxUIObject ()
FxNativeHandle	getHandle () const
void	setHandle (FxNativeHandle handle)
void	setParent (CFxUIObject *parent)
CFxUIObject *	parent ()
const CFxUIObject *	parent () const
void	setObjectName (const CFxUIString &objectName)
CFxUIString	objectName () const
bool	setProperty (const char *name, const CFxUIVariant &value)
CFxUIVariant	property (const char *name)
CFxUIList< CFxUIObject * >	children () const
template<typename T>
CFxUIList< T >	findChildren (const CFxUIString &name=CFxUIString())
void	blockSignals (bool block)
bool	signalsBlocked () const

Additional Inherited Members
Static Public Member Functions inherited from CFxUIBaseView
static void	setTabOrder (CFxUIObject *first, CFxUIObject *second)
Protected Member Functions inherited from CFxUIObject
CFxUIObject *	sender ()
Protected Attributes inherited from CFxUIObject
CFxUIObjectImpl *	m_pImpl
CFxUIObjectData *	m_pData

Detailed Description

Class CFxUITableView provides a default model/view implementation of a tree view.

Definition at line 47 of file FxUITableView.h.

Member Enumeration Documentation

UIHeaderResizeMode

enum CFxUITableView::UIHeaderResizeMode

This enum defines the behavior of the header sections.

Enumerator
Interactive	The user can resize the section.
Stretch	HeaderView will automatically resize the section to fill the available space.
Fixed	The user cannot resize the section.
ResizeToContents	HeaderView will automatically resize the section to its optimal size based on the contents of the entire column or row.
Custom	Use Fixed instead.

Definition at line 79 of file FxUITableView.h.

UIMouseClickEvent

enum CFxUITableView::UIMouseClickEvent

Enumerator
None	No button.
Left	Left button.
Middle	Middle button.
Right	Right button.

Definition at line 101 of file FxUITableView.h.

UISelectionBehavior

enum CFxUITableView::UISelectionBehavior

This enum type defines the selection behavior of items in FxUITreeView.

Enumerator
SelectItems	This enum selects the single items.
SelectRows	This enum selects only the rows.
SelectColumns	This enum selects only the columns.

Definition at line 54 of file FxUITableView.h.

UISelectionFlag

enum CFxUITableView::UISelectionFlag

This enum defines way the selection will be updated.

Enumerator
NoUpdate	No selection will be made.
Clear	The complete selection will be cleared.
Select	All specified indexes will be selected.
Deselect	All specified indexes will be deselected.
Rows	All indexes will be expanded to span rows.
Columns	All indexes will be expanded to span columns.
ClearAndSelect	A combination of Clear and Select, provided for convenience.

Definition at line 91 of file FxUITableView.h.

UISelectionMode

enum CFxUITableView::UISelectionMode

This enum indicates how the view responds to user selections.

Enumerator
NoSelection	Items cannot be selected.
SingleSelection	When the user selects an item, any already-selected item becomes unselected, and the user cannot unselect the selected item by clicking on it.
MultiSelection	When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone. Multiple items can be toggled by dragging the mouse over them.
ExtendedSelection	If the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item. Multiple items can be selected by dragging the mouse over them.
ContiguousSelection	If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item.

Definition at line 64 of file FxUITableView.h.

Constructor & Destructor Documentation

CFxUITableView()

CFxUITableView::CFxUITableView

(

)

Constructor

~CFxUITableView()

CFxUITableView::~CFxUITableView

(

)

Destructor

Member Function Documentation

clearSelection()

void CFxUITableView::clearSelection

(

)

Deselects all selected items. The current index will not be changed.

columnWidth()

int CFxUITableView::columnWidth

(

int

iColumn

)

const

Gets the column width.

Returns

the width.

currentIndex()

CFxUIModelIndex CFxUITableView::currentIndex

(

)

const

Gets the current index of item.

Returns

the index.

getModel()

CFxUIAbstractItemModel * CFxUITableView::getModel

(

)

itemClicked()

CFxUISignal< void(const CFxUIModelIndex &)> & CFxUITableView::itemClicked

(

)

Signal is emitted when item is clicked.

mouseClicked()

CFxUISignal< void(CFxUIModelIndex, CFxUITableView::UIMouseClickEvent)> & CFxUITableView::mouseClicked

(

)

Signal is emitted when clicked.

openPersistentEditor()

void CFxUITableView::openPersistentEditor

(

const CFxUIModelIndex &

index

)

Opens a persistent editor at given index.

Parameters

index

Input.

selectedIndexes()

std::vector< CFxUIModelIndex > CFxUITableView::selectedIndexes

(

)

const

returns a list of all selected and non-hidden item indexes in the view. The list contains no duplicates, and is not sorted.

selectionChanged()

CFxUISignal< void(void)> & CFxUITableView::selectionChanged

(

)

Signal is emitted when selection of view is changed.

selectRow()

void CFxUITableView::selectRow	(	CFxUITableView::UISelectionFlag	flag,
		CFxUIModelIndex	index )

Sets the row selected.

Parameters

first	flag Input.This enum is of type CFxUITableView::UISelectionFlag.
second	index Input. Selects the row at provided index.

setColumnHidden()

void CFxUITableView::setColumnHidden	(	int	iColumn,
		bool	bHide )

Sets the column hidden.

Parameters

first	iColumn Input.
second	bHide Input. If true, column is hidden.

setColumnWidth()

void CFxUITableView::setColumnWidth	(	int	iColumn,
		int	iWidth )

Sets the width of the given column to the width specified.

Parameters

first	iColumn Input.
second	iWidth Input.

setCurrentIndex()

void CFxUITableView::setCurrentIndex

(

CFxUIModelIndex

index

)

Sets the current item to be the item at index.

Parameters

_index_

Input.

setHorizontalHeaderResizeSection()

void CFxUITableView::setHorizontalHeaderResizeSection	(	CFxUITableView::UIHeaderResizeMode	mode,
		int	iColumn )

Sets the resize mode for column.

Parameters

first	mode Input. This is an enum defined in CFxUITableView::UIHeaderResizeMode.
second	iColumn Input.

setHorizontalHeaderStretchLastSection()

void CFxUITableView::setHorizontalHeaderStretchLastSection

(

bool

bEnable

)

Sets whether the last visible section in the header takes up all the available space.

Parameters

_bEnable_

Input.

setHorizontalScrollBarPolicy()

void CFxUITableView::setHorizontalScrollBarPolicy

(

CFxUIBaseView::UIScrollBarPolicy

mode

)

Sets the policy for the horizontal scroll bar

Parameters

_mode

Input. This is an enum defined in CFxUIBaseView::UIScrollBarPolicy.

setHorzHeaderHidden()

void CFxUITableView::setHorzHeaderHidden

(

bool

bHide

)

Sets the Horizontal header hidden.

Parameters

bHide

Input. If true, header is hidden.

setHorzScrollBarDisable()

void CFxUITableView::setHorzScrollBarDisable

(

bool

bDisable

)

Sets the Horizontal scrollbar disable.

Parameters

bDisable

Input. If true, Horizontal scrollbar is disabled.

setModel()

void CFxUITableView::setModel

(

CFxUIAbstractItemModel *

model

)

Sets the model for the view to present.

Parameters

_model_

Input.

setSelectionBehavior()

void CFxUITableView::setSelectionBehavior

(

CFxUITableView::UISelectionBehavior

behavior

)

Sets the selection behavior for tree.

Parameters

_behavior_

Input. This is an enum defined in CFxUITableView::UISelectionBehavior.

setSelectionMode()

void CFxUITableView::setSelectionMode

(

CFxUITableView::UISelectionMode

mode

)

Sets the selection mode for tree.

Parameters

_mode_

Input. This is an enum defined in CFxUITableView::UISelectionMode.

setShowGrid()

void CFxUITableView::setShowGrid	(	bool	visible,
		int	mask = CFxUIModelIndex::Horizontal|CFxUIModelIndex::Vertical )

Sets the grid lines property and optionally the orientation of visible grid lines.

Parameters

visible	A Boolean value which specifies if border and divider lines should be visible.
mask	A bitmask indicating visibility for horizontal and vertical lines if visible is true. If not specified, both orientations are set by default.

setSortingEnabled()

void CFxUITableView::setSortingEnabled

(

bool

bEnable

)

Sets whether whether sorting is enabled.

Parameters

_bEnable_

Input. If true, sorting is enabled for the tree; if false, sorting is not enabled.

setVerticalHeaderHidden()

void CFxUITableView::setVerticalHeaderHidden

(

bool

bHide

)

Sets the vertical header hidden.

Parameters

bHide

Input. If true, header is hidden.

setVerticalHeaderStretchLastSection()

void CFxUITableView::setVerticalHeaderStretchLastSection

(

bool

bEnable

)

Sets whether the last visible section in the vertical header takes up all the available space.

Parameters

_bEnable_

Input.

setVerticalScrollBarPolicy()

void CFxUITableView::setVerticalScrollBarPolicy

(

CFxUIBaseView::UIScrollBarPolicy

mode

)

Sets the policy for the vertical scroll bar

Parameters

_mode

Input. This is an enum defined in CFxUIBaseView::UIScrollBarPolicy.

showGrid()

bool CFxUITableView::showGrid

(

)

Gets the grid lines visibility as a bitmask.

Returns

The visibility of any grid lines.

sortByColumn()

void CFxUITableView::sortByColumn	(	int	column,
		int	order )

Sets the sorting criterion and sorts the table.

Parameters

_column_	Input. The column to be used as sorting key.
_order_	Input. The order of the sorting result, this may be CFxUISortOrder::AscendingOrder or CFxUISortOrder::DescendingOrder.

---

The documentation for this class was generated from the following file:

• FxUITableView.h