Wizt::StatusIndicator Struct Reference

Base class for convenient messing around with the status to be displayed for a certain object. More...

#include </home/werner/origo/vish/ocean/shrimp/VObjectStatus.hpp>

List of all members.

Public Member Functions

• bool setStatusError (const RefPtr< ValuePool > &Context, const string &what, bool AnnouncePublic=true) const

  Indicate an error happening to this object.
  

• bool setStatusInfo (const RefPtr< ValuePool > &Context, const string &what) const

  Set the status info text for the given object, relative to the given context.
  

• bool setStatusWarning (const RefPtr< ValuePool > &Context, const string &what) const

  Indicate an informative warning message happening to this object.
  

• StatusIndicator (VObject *what, const string &initialtext="", int EL=0)

  Constructor.
  

• virtual ~StatusIndicator ()

  Destructor, virtual, such that dynamic type information is possible.
  

Public Attributes

• TypedSlot< VObjectStatus > StatusInfo

  The exported slot.
  

---

Detailed Description

Base class for convenient messing around with the status to be displayed for a certain object.

Examples:

InteractivePoint.cpp.

---

Constructor & Destructor Documentation

Wizt::StatusIndicator::StatusIndicator	(	VObject *	what,
		const string &	initialtext = "",
		int	EL = 0
	)

Constructor.

struct MyObject : VObject, StatusIndicator
{
        MyObject(...) 
        : VObject(...), 
        StatusIndicator(this)
        {}
};

---

Member Function Documentation

bool Wizt::StatusIndicator::setStatusError	(	const RefPtr< ValuePool > &	Context,
		const string &	what,
		bool	AnnouncePublic = true
	)		const

Indicate an error happening to this object.

Parameters:

AnnouncePublic

If true (default) then the error messages produced here will also be announced to the VActionNotifier which possibly pops up some intentionally annoying window to the user, and might go into some logfile.

bool Wizt::StatusIndicator::setStatusInfo	(	const RefPtr< ValuePool > &	Context,
		const string &	what
	)		const

Set the status info text for the given object, relative to the given context.

Returns:

Always returns true. The sole purpose of the return value is to enable one-line if-return statements such as

                   bool f(Context)
                   {
                        if ( notgood() ) return setStatusInfo( Context, "not good");
                        ...
                        return setStatusInfo( Context, "all is fine" );
                   }

---

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

• ocean/shrimp/VObjectStatus.hpp
• ocean/shrimp/VObjectStatus.cpp