VDKForm Class Reference

VDKForm widgets, generally the outermost widget container. More...

#include <forms.h>

Inheritance diagram for VDKForm:

List of all members.

Public Member Functions

• VDKForm (VDKApplication *app, char *title=(char *) NULL, int mode=v_box, GtkWindowType display=GTK_WINDOW_TOPLEVEL)
• VDKForm (VDKForm *owner, char *title=(char *) NULL, int mode=v_box, GtkWindowType display=GTK_WINDOW_TOPLEVEL)
• virtual ~VDKForm ()
• bool Destroy ()
• virtual int isA ()
• VDKBox * Box ()
• virtual void Show (GtkWindowPosition pos=GTK_WIN_POS_NONE)
• virtual void Hide ()
• virtual void ShowModal (GtkWindowPosition pos=GTK_WIN_POS_NONE)
• bool IsModal ()
• virtual void Add (VDKObject *obj, int justify=l_justify, int expand=TRUE, int fill=TRUE, int padding=1)
• VDKForm * Owner ()
• virtual bool CanClose (void)
• virtual void Close (void)
• virtual void Setup (void)=0
• void Raise ()
• void Lower ()
• void SetVisible (bool flag)
• bool GetVisible ()

Public Attributes

• VDKReadWriteValueProp< VDKForm,
  bool > Visible

Protected Attributes

• VDKApplication * app
• ChildList childs
• GtkWidget * window
• VDKBox * box
• bool isModal
• bool never_showed
• VDKPoint _oldSize
• int modalCount

Private Member Functions

• VDKForm (VDKForm &)
• VDKForm & operator= (VDKForm &)

---

Detailed Description

VDKForm widgets, generally the outermost widget container.

This class provides a common interface with GTK+ windows that are here called "Forms". VDKForm provides common functionalities for all derived classes.

---

Constructor & Destructor Documentation

VDKForm::VDKForm

(

VDKForm &

)

[inline, private]

copy and assignement prohibited

VDKForm::VDKForm	(	VDKApplication *	app,
		char *	title = (char *) NULL,
		int	mode = v_box,
		GtkWindowType	display = GTK_WINDOW_TOPLEVEL
	)

constructor, makes a main form, application child

Parameters:

	app	the application that owns the form
	title
	mode	as inner box should be, either vertical (v_box) or horizontal (h_box)
	display	display type can be one of the following: GTK_WINDOW_TOPLEVEL GTK_WINDOW_DIALOG GTK_WINDOW_POPUP behavio_ vdksdl_form_hur depends on window manager

VDKForm::VDKForm	(	VDKForm *	owner,
		char *	title = (char *) NULL,
		int	mode = v_box,
		GtkWindowType	display = GTK_WINDOW_TOPLEVEL
	)

constructor, makes a child form

Parameters:

	owner	the form that owns the child form
	title
	mode	as inner box should be, either vertical (v_box) or horizontal (h_box)
	display	display type can be one of the following: GTK_WINDOW_TOPLEVEL GTK_WINDOW_DIALOG GTK_WINDOW_POPUP behaviour depends on window manager

VDKForm::~VDKForm

(

)

[virtual]

Destructor

---

Member Function Documentation

VDKForm& VDKForm::operator=

(

VDKForm &

)

[inline, private]

copy and assignement prohibited

bool VDKForm::Destroy

(

)

Explicitely destroy a form.

Reimplemented from VDKObject.

virtual int VDKForm::isA

(

)

[inline, virtual]

returns an enum id (incomplete and not so useful)

Reimplemented from VDKObject.

VDKBox* VDKForm::Box

(

)

[inline]

return inner box

void VDKForm::Show

(

GtkWindowPosition

pos = GTK_WIN_POS_NONE

)

[virtual]

Shows form.

Parameters:

pos

indicates initial form position, can be one of the following: GTK_WIN_POS_NONE GTK_WIN_POS_CENTER GTK_WIN_POS_MOUSE GTK_WIN_POS_CENTER_ALWAYS

void VDKForm::Hide

(

)

[virtual]

Hides form

void VDKForm::ShowModal

(

GtkWindowPosition

pos = GTK_WIN_POS_NONE

)

[virtual]

Shows a form in modal behaviour

Parameters:

pos

indicates initial form position, can be one of the following: GTK_WIN_POS_NONE GTK_WIN_POS_CENTER GTK_WIN_POS_MOUSE GTK_WIN_POS_CENTER_ALWAYS

bool VDKForm::IsModal

(

)

[inline]

Return if a showed window is modal or not

void VDKForm::Add	(	VDKObject *	obj,
		int	justify = l_justify,
		int	expand = TRUE,
		int	fill = TRUE,
		int	padding = 1
	)			[virtual]

Add an object to the form. Tip: <obj> will be actually added to inner box same as form->Box()->Add();

Parameters:

	obj	the object to be added
	justify	where the object wil be added, can be: l_justify packed to end (appended) r_justify packed to start (prepended)
	expand	if true objet will expand from container center
	fill	if true object will fill all available space
	padding	how many pixels are left around object

Reimplemented from VDKObject.

VDKForm* VDKForm::Owner

(

)

[inline]

Return form owner Tip: returns NULL id <this> is main form

Reimplemented from VDKObject.

bool VDKForm::CanClose

(

void

)

[virtual]

Placeholder for subclasses. User should override this returning a false (don't close) or true (close) value.

Reimplemented in VDKFileDialog, and VDKFileIconDialog.

void VDKForm::Close

(

void

)

[virtual]

Closes the form, if form is main application form it quits application as well. Call CanClose() before, if it returns true closes the form otherwise form won't be closed.

virtual void VDKForm::Setup

(

void

)

[pure virtual]

Must be overridden by subclasses, in this method user fills form with useful widgets

Reimplemented from VDKObject.

Implemented in VDKFileDialog, VDKFileSel, VDKFileChooser, and VDKFileIconDialog.

void VDKForm::Raise

(

)

Raises form

void VDKForm::Lower

(

)

Lower form

void VDKForm::SetVisible

(

bool

flag

)

[inline]

Set object visibility

Parameters:

visible

either true or false

Reimplemented from VDKObject.

bool VDKForm::GetVisible

(

)

[inline]

Returns object visibility

Reimplemented from VDKObject.

---

Member Data Documentation

VDKApplication* VDKForm::app [protected]

owner application address

ChildList VDKForm::childs [protected]

child and child garbage list

GtkWidget* VDKForm::window [protected]

underlaying gtk+ window

VDKBox* VDKForm::box [protected]

default inner box

bool VDKForm::isModal [protected]

modal flag

bool VDKForm::never_showed [protected]

never showed flag

VDKPoint VDKForm::_oldSize [protected]

size storage

int VDKForm::modalCount [protected]

counts how many modal childs we have should be always max 1

VDKReadWriteValueProp<VDKForm,bool> VDKForm::Visible

Setting this property will show/hide or get object visibility

Reimplemented from VDKObject.

---

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

• forms.h
• forms.cc

---