celPcCommon Class Reference

This is a common implementation for a property class from which all other property classes can inherit. More...

#include <celtool/stdpcimp.h>

Inheritance diagram for celPcCommon:

[legend]

List of all members.

Public Member Functions
bool	Bug (char const *desc,...) const
	Report bug. Always returns false.
bool	Error (char const *desc,...) const
	Report error. Always returns false.
bool	Notify (char const *desc,...) const
	Just notify something. Always returns false.
bool	Warning (char const *desc,...) const
	Report warning. Always returns false.
Protected Member Functions
void	AddAction (int idx, const char *id)
	Helper function to setup an action.
void	AddProperty (size_t idx, const char *id, celDataType type, bool readonly, const char *desc, void *prop)
	Helper function to setup properties.
void	SetActionMask (const char *mask)
	Setup the mask used for receiving action messages.

---

Detailed Description

This is a common implementation for a property class from which all other property classes can inherit.

This makes it easier to write a property class.

Definition at line 96 of file stdpcimp.h.

---

Member Function Documentation

void celPcCommon::AddAction	(	int	idx,
		const char *	id
	)			[inline, protected]

Helper function to setup an action.

Definition at line 131 of file stdpcimp.h.

void celPcCommon::AddProperty	(	size_t	idx,
		const char *	id,
		celDataType	type,
		bool	readonly,
		const char *	desc,
		void *	prop
	)			[inline, protected]

Helper function to setup properties.

Parameters:

	idx	is a numerical index for the property starting at 0.
	id	is the id string ('bla').
	type	is the type for the property.
	readonly
	desc	is the description.
	pointer	is the pointer of the field this property corresponds with or 0 if it requires manual intervention.

Definition at line 152 of file stdpcimp.h.

bool celPcCommon::Bug	(	char const *	desc,
			...
	)			const

Report bug. Always returns false.

bool celPcCommon::Error	(	char const *	desc,
			...
	)			const

Report error. Always returns false.

bool celPcCommon::Notify	(	char const *	desc,
			...
	)			const

Just notify something. Always returns false.

void celPcCommon::SetActionMask

(

const char *

mask

)

[protected]

Setup the mask used for receiving action messages.

bool celPcCommon::Warning	(	char const *	desc,
			...
	)			const

Report warning. Always returns false.

---

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

• celtool/stdpcimp.h