cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk Class Reference

Private class of the configuration dialogs which deals with all internal issues of the GTK toolkit. More...

#include <cvrViewerBaseGtk.h>

Inheritance diagram for cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk:

[legend]

Collaboration diagram for cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk:

[legend]

List of all members.

Public Member Functions
	tk (viewerBase::configDialog &parent)
virtual	~tk ()
virtual bool	build ()
virtual bool	show ()
virtual bool	hide ()
virtual bool	destroy ()
tk &	copy (const tk &other)
virtual bool	updateParameters ()
Protected Attributes
viewerBase::configDialog &	parent_
viewerBase::parameters *&	params_
bool	dlgShown_
bool	dlgBuild_
GtkWidget *	dialog_
GtkWidget *	vbox_
GtkWidget *	actionArea_
GtkWidget *	cancelButton_
GtkWidget *	applyButton_
GtkWidget *	okButton_
mutex	lock_
static gboolean	cbShow (gpointer data)
static gint	cbCloseWindow (GtkWidget *widget, GdkEvent *event, gpointer data)
static void	cbOnCancelButtonClicked (GtkButton *button, gpointer data)
static void	cbOnApplyButtonClicked (GtkButton *button, gpointer data)
static void	cbOnOkButtonClicked (GtkButton *button, gpointer data)
virtual bool	onCancelButtonClicked ()
virtual bool	onApplyButtonClicked ()
virtual bool	onOkButtonClicked ()

---

Detailed Description

Private class of the configuration dialogs which deals with all internal issues of the GTK toolkit.

---

Constructor & Destructor Documentation

cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::tk

(

viewerBase::configDialog &

parent

)

Constructor.

This constructor does not call build(), since at creation time GTK may not be initialized yet.

virtual cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::~tk

(

)

[virtual]

Destructor.

Reimplemented in cvr::viewer2D::viewer2D::configDialog::viewer2D::configDialog::tk.

---

Member Function Documentation

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::build

(

)

[virtual]

Create window.

Reimplemented in cvr::viewer2D::viewer2D::configDialog::viewer2D::configDialog::tk.

static gint cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::cbCloseWindow	(	GtkWidget *	widget,
		GdkEvent *	event,
		gpointer	data
	)			[static, protected]

Callback function called when the user selects the "close window" button of the window.

This method overrides the delete structure with a hide().

static void cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::cbOnApplyButtonClicked	(	GtkButton *	button,
		gpointer	data
	)			[static, protected]

Callback function called when the user has pressed the apply button.

static void cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::cbOnCancelButtonClicked	(	GtkButton *	button,
		gpointer	data
	)			[static, protected]

Callback function called when the user has pressed the cancel button.

static void cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::cbOnOkButtonClicked	(	GtkButton *	button,
		gpointer	data
	)			[static, protected]

Callback function called when the user has pressed the ok button.

static gboolean cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::cbShow

(

gpointer

data

)

[static, protected]

Static functions used by GTK as callbacks and their corresponding local versions.

Even if the CVR-Lib forbids the use of prefixes, here an exception has been done with "cb", meaning "callback", which is used to keep a direct correspondence between the GTK required static function and a local instance-bounded virtual method. Callback function called when the user has explicitelly indicated a show()

tk& cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::copy

(

const tk &

other

)

Copy another mainWindow toolkit configuration.

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::destroy

(

)

[virtual]

Destroy window.

Reimplemented in cvr::viewer2D::viewer2D::configDialog::viewer2D::configDialog::tk.

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::hide

(

)

[virtual]

Hide this window.

Reimplemented in cvr::viewer2D::viewer2D::configDialog::viewer2D::configDialog::tk.

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::onApplyButtonClicked

(

)

[protected, virtual]

On apply button.

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::onCancelButtonClicked

(

)

[protected, virtual]

On apply button.

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::onOkButtonClicked

(

)

[protected, virtual]

On ok button.

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::show

(

)

[virtual]

Show the window.

Reimplemented in cvr::viewer2D::viewer2D::configDialog::viewer2D::configDialog::tk.

virtual bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::updateParameters

(

)

[virtual]

Update parameters.

Since the base class has no attributes, this method does nothing but to establish the virtual interface.

Since the params_ attribute of the class is just an alias for the ones in the enclosing configDialog class, no pointer needs to be adjusted.

Reimplemented in cvr::viewer2D::viewer2D::configDialog::viewer2D::configDialog::tk.

---

Member Data Documentation

GtkWidget* cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::actionArea_ [protected]

Action area.

GtkWidget* cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::applyButton_ [protected]

Apply button.

GtkWidget* cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::cancelButton_ [protected]

Cancel button.

GtkWidget* cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::dialog_ [protected]

The main window.

In GTK a window widget should be a pop up menu or the top window application. It is therefore more appropriate to use the gtk_dialog to hold the images, as they have less restrictions and are easier to manipulate.

bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::dlgBuild_ [protected]

Flag that indicates if the window is currently being shown.

bool cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::dlgShown_ [protected]

Flag that indicates if the window is currently being shown.

mutex cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::lock_ [protected]

Protect all members from multiple access.

GtkWidget* cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::okButton_ [protected]

Ok button.

viewerBase::parameters*& cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::params_ [protected]

Pointer to a read-writable version of the parameters.

It is a reference to the parameters pointer in the configDialog enclosing class, initialized at construction time. This avoids inconsistencies between the objects being used.

viewerBase::configDialog& cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::parent_ [protected]

Reference to the class that owns this instance.

GtkWidget* cvr::viewerBase::viewerBase::configDialog::viewerBase::configDialog::tk::vbox_ [protected]

Vertical box for packing all components in inherited classes.

---

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

• cvrViewerBaseGtk.h