vdk 2.4.0
Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions
VDKForm Class Reference

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

#include <forms.h>

Inheritance diagram for VDKForm:
VDKObject VDKNotCopyAble VDKFileChooser VDKFileDialog VDKFileIconDialog VDKFileSel VDKFileSaveAsDialog

List of all members.

Public Member Functions

Public Attributes

Protected Attributes

Private Member Functions


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:
appthe application that owns the form
title
modeas inner box should be, either vertical (v_box) or horizontal (h_box)
displaydisplay 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:
ownerthe form that owns the child form
title
modeas inner box should be, either vertical (v_box) or horizontal (h_box)
displaydisplay 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

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:
objthe object to be added
justifywhere the object wil be added, can be:
  • l_justify packed to end (appended)
  • r_justify packed to start (prepended)
expandif true objet will expand from container center
fillif true object will fill all available space
paddinghow many pixels are left around object

Reimplemented from VDKObject.

VDKBox* VDKForm::Box ( ) [inline]

return inner box

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.

bool VDKForm::Destroy ( )

Explicitely destroy a form.

Reimplemented from VDKObject.

bool VDKForm::GetVisible ( ) [inline]

Returns object visibility

Reimplemented from VDKObject.

void VDKForm::Hide ( ) [virtual]

Hides form

virtual int VDKForm::isA ( ) [inline, virtual]

returns an enum id (incomplete and not so useful)

Reimplemented from VDKObject.

bool VDKForm::IsModal ( ) [inline]

Return if a showed window is modal or not

void VDKForm::Lower ( )

Lower form

VDKForm& VDKForm::operator= ( VDKForm ) [inline, private]

copy and assignement prohibited

VDKForm* VDKForm::Owner ( ) [inline]

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

Reimplemented from VDKObject.

void VDKForm::Raise ( )

Raises form

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, VDKFileChooser, VDKFileSel, and VDKFileIconDialog.

void VDKForm::SetVisible ( bool  visible) [inline]

Set object visibility

Parameters:
visibleeither true or false

Reimplemented from VDKObject.

void VDKForm::Show ( GtkWindowPosition  pos = GTK_WIN_POS_NONE) [virtual]

Shows form.

Parameters:
posindicates 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::ShowModal ( GtkWindowPosition  pos = GTK_WIN_POS_NONE) [virtual]

Shows a form in modal behaviour

Parameters:
posindicates 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

Member Data Documentation

size storage

owner application address

VDKBox* VDKForm::box [protected]

default inner box

child and child garbage list

bool VDKForm::isModal [protected]

modal flag

int VDKForm::modalCount [protected]

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

bool VDKForm::never_showed [protected]

never showed flag

VDKReadWriteValueProp<VDKForm,bool> VDKForm::Visible

Setting this property will show/hide or get object visibility

Reimplemented from VDKObject.

GtkWidget* VDKForm::window [protected]

underlaying gtk+ window


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