This is a base class for derived VDKCustomList and VDKCustomTree Provides common functionalities for both child classes. More...

#include <vdkcustom.h>

Inheritance diagram for VDKCustom:

List of all members.

Public Member Functions

int ColumnClicked ()
GtkSelectionMode SelectionMode ()
GtkWidget * CustomWidget ()
void ActiveTitle (int col, bool flag=true)
void ActiveTitles (bool flag=true)
void EnableTitles (bool flag=true)
void Freeze ()
void Thaw ()
virtual void Clear ()
int Size ()
void ColumnSize (int col, int size)
void AutoResizeColumn (int col, bool flag)
virtual void SetForeground (VDKRgb, GtkStateType)
virtual void SetFont (VDKFont *)

Public Attributes

VDKReadWriteValueProp
< VDKCustom, GtkPolicyType > VPolicy
VDKReadWriteValueProp
< VDKCustom, GtkPolicyType > HPolicy
VDKReadWriteValueProp
< VDKCustom, GtkShadowType > BorderShadow
VDKReadWriteValueProp
< VDKCustom, int > RowHeight
VDKReadWriteValueProp
< VDKCustom, bool > AutoResize
VDKReadWriteValueProp
< VDKCustom, VDKRgb > SelectedForeground
VDKReadWriteValueProp
< VDKCustom, VDKRgb > UnselectedBackground
VDKReadWriteValueProp
< VDKCustom, VDKRgb > UnselectedForeground
VDKObjectArray Titles
VDKReadOnlyValueProp
< VDKCustom, int > SelectedTitle

Protected Member Functions

virtual void SetBackground (VDKRgb color, GtkStateType state=GTK_STATE_NORMAL)

Detailed Description

This is a base class for derived VDKCustomList and VDKCustomTree Provides common functionalities for both child classes.

Programming tips

VDKCustom operations are dependent on selection mode that can be one of the following:

GTK_SELECTION_SINGLE (default)
GTK_SELECTION_BROWSE
GTK_SELECTION_MULTIPLE
GTK_SELECTION_EXTENDED

Signals

Signals are available for all modes except browse one, but the way you can use them is different for each mode. Basically in single mode you may use Selection property while in other modes you may use Selections() method. It's possible to connect with "click_column" signal using dynamics tables provided that use connects with <gtk> arg set to false.

  SignalConnect(aCustom, "click_column",&SomeClass::Response,false);

Member Function Documentation

void VDKCustom::ActiveTitle	(	int	col,
		bool	flag = `true`
	)

Sets/unsets active titile

Parameters:

col,ordinal	position of the active title
flag,either	true (set) or false (unset)

void VDKCustom::ActiveTitles ( bool flag = true )

Same as above but acts on the entire tuple.

void VDKCustom::AutoResizeColumn	(	int	col,
		bool	flag
	)

Sets/unsets column auto-resize capability

Parameters:

col,ordinal	position
flag,either	true (sets) or false (unsets)

virtual void VDKCustom::Clear ( ) [inline, virtual]

Clear widget

Reimplemented in VDKCustomList, and VDKCustomTree.

int VDKCustom::ColumnClicked ( ) [inline]

Returns wich column was clicked

void VDKCustom::ColumnSize	(	int	col,
		int	size
	)

Set column fixed size

Parameters:

col,ordinal	position
size,in	pixels

GtkWidget* VDKCustom::CustomWidget ( ) [inline]

Returns underlying custom widget.

Tip:: Use this to access to custom widget, using VDKObject::Widget() will access to the widget container not to custom widget itself.

void VDKCustom::EnableTitles ( bool flag = true )

Set/unset titles sensitivity

Parameters:

flag,if false titles will be grayed as well.

void VDKCustom::Freeze ( ) [inline]

Freezes widget during time consuming updating operations

GtkSelectionMode VDKCustom::SelectionMode ( )

Returns selection mode

void VDKCustom::SetBackground	(	VDKRgb	color,
		GtkStateType	state = `GTK_STATE_NORMAL`
	)		`[protected, virtual]`

Sets object background

Parameters:

color	a VDKRgb object
state	can be one of the gtk+ widget states

Reimplemented from VDKObject.

void VDKCustom::SetFont ( VDKFont * f ) [virtual]

Sets object font

Reimplemented from VDKObject.

void VDKCustom::SetForeground	(	VDKRgb	color,
		GtkStateType	state
	)		`[virtual]`

Sets object foreground

Parameters:

color	a VDKRgb object
state	can be one of the gtk+ widget states

Reimplemented from VDKObject.

int VDKCustom::Size ( ) [inline]

Returns how many rows/nodes are into custom widget

void VDKCustom::Thaw ( ) [inline]

Unfreeze

Member Data Documentation

VDKReadWriteValueProp<VDKCustom,bool> VDKCustom::AutoResize

Use this to set/get auto resize capablity for al columns

VDKReadWriteValueProp<VDKCustom,GtkShadowType> VDKCustom::BorderShadow

Use this to get/set border shadow

VDKReadWriteValueProp<VDKCustom,GtkPolicyType> VDKCustom::HPolicy

Use this to get/set hor. scrollbar policy

VDKReadWriteValueProp<VDKCustom,int> VDKCustom::RowHeight

Use this to get/set row height

Tip: By default row height is computed using default font.

VDKReadWriteValueProp<VDKCustom,VDKRgb> VDKCustom::SelectedForeground

Use this to set colors for selected lines if they should be different from defaults. All new added rows will have this colors. VDKReadWriteValueProp<VDKCustom,VDKColor*> SelectedBackground;

Use this to set colors for selected lines if they should be different from defaults. All new added rows will have this colors.

VDKReadOnlyValueProp<VDKCustom,int> VDKCustom::SelectedTitle

<read-only>, use this to know wich title was selected (if any)

VDKObjectArray VDKCustom::Titles

Since column titles are themselves objects you can use this to access them and set object properties like this:

    custom->Titles[0]->Enabled = false; 
    custom->Titles[0]->Normalbackground = VDKRgb("dodgerblue");

VDKReadWriteValueProp<VDKCustom,VDKRgb> VDKCustom::UnselectedBackground

its use is deprecated, mantained for compat, reverts to NormalBackground

VDKReadWriteValueProp<VDKCustom,VDKRgb> VDKCustom::UnselectedForeground

its use is deprecated, mantained for compat, reverts to Foreground

VDKReadWriteValueProp<VDKCustom,GtkPolicyType> VDKCustom::VPolicy

Use this to get/set vert. scrollbar policy

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

vdkcustom.h
vdkcustom.cc