PTextObject Class Reference

This class simply represent an abstract text-based object. More...

#include <PTextObject.h>

Inheritance diagram for PTextObject:

Public Member Functions
	PTextObject ()
	PTextObject (const std::string &text)
	PTextObject (PTextObject &object)
virtual	~PTextObject ()
virtual bool	SetProperty (std::string, Variant v)
virtual Variant	GetProperty (std::string) const
virtual ObjectValidationError	ValidateProperty (std::string, Variant v) const
virtual ObjectValidationError	ValidateProperty (std::string) const
virtual void	SetText (const std::string &text)
virtual void	SetDirection (int i)
virtual std::string	GetText () const
virtual unsigned long int	GetNumCharacters ()
Public Member Functions inherited from PWidget
	PWidget ()
	PWidget (const PWidget &pw)
	PWidget (pInt x, pInt y, pInt width, pInt height, bool visible)
virtual	~PWidget ()
virtual bool	RotoZoom (pDouble angle, pDouble zoomx, pDouble zoomy, pInt smooth)
virtual bool	SetPoint (pInt x, pInt y, PColor col)
virtual PColor	GetPixel (pInt x, pInt y)
virtual void	SetParent (PWidget *widget)
	This unconditionally sets the parent widget.
virtual PWidget *	GetParent ()
virtual bool	IsParent (PWidget *parent)
virtual bool	Draw ()
virtual void	SetPosition (pInt x, pInt y)
	This sets the widget's position on its parent widget.
virtual void	SetZoomX (pDouble x)
	This sets the widget's position on its parent widget.
virtual void	SetZoomY (pDouble x)
	This sets the widget's position on its parent widget.
virtual void	SetRotation (pDouble x)
	This sets the widget's position on its parent widget.
virtual void	SetWidth (pInt w)
virtual void	SetHeight (pInt h)
virtual pInt	GetX () const
virtual pInt	GetY () const
virtual pInt	GetWidth () const
virtual pInt	GetHeight () const
virtual void	SetBackgroundColor (const PColor &color)
virtual PColor	GetBackgroundColor ()
virtual bool	AddSubWidget (PWidget *widget)
virtual bool	RemoveSubWidget (PWidget *widget)
virtual bool	RemoveSubWidgets ()
virtual bool	RemoveLastSubWidget ()
	This is probably pretty useless.
virtual void	Show ()
virtual void	Hide ()
virtual bool	IsVisible () const
Public Member Functions inherited from PEBLObjectBase
	PEBLObjectBase ()
	Standard Constructor.
	PEBLObjectBase (ComplexDataType cdt)
	Standard Constructor.
	PEBLObjectBase (const PEBLObjectBase &pob)
virtual	~PEBLObjectBase ()
	Standard Destructor.
virtual bool	InitializeProperty (std::string name, Variant v)
Variant	GetProperty (std::string) const
ComplexDataType	GetType ()
virtual std::ostream &	PrintProperties (std::ostream &out)
virtual Variant	GetPropertyList ()

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const
	An inheritable printing class used by PEBLObjectBase::operator<<.
virtual std::string	ObjectName () const

Protected Attributes
bool	mChanged
std::string	mText
int	mDirection
Protected Attributes inherited from PWidget
pInt	mX
pInt	mY
pInt	mDrawX
pInt	mDrawY
pInt	mWidth
pInt	mHeight
pDouble	mZoomX
pDouble	mZoomY
pDouble	mRotation
PColor	mBackgroundColor
	The background color of the widget. if alpha = 0, will not be painted.
std::list< PWidget * >	mSubWidgets
bool	mIsVisible
PWidget *	mParent
Protected Attributes inherited from PEBLObjectBase
ComplexDataType	mCDT
std::map< std::string, Variant >	mProperties

Detailed Description

This class simply represent an abstract text-based object.

Definition at line 40 of file PTextObject.h.

Constructor & Destructor Documentation

PTextObject() [1/3]

PTextObject::PTextObject

(

)

Definition at line 37 of file PTextObject.cpp.

                        :
    PWidget(0,0,0,0,false),
    mChanged(true),
    mText(""),
    mDirection(1)
{
    InitializeProperty("TEXT","");
    InitializeProperty("DIRECTION",1);
    InitializeProperty("LINEHEIGHT",0);
 
}

References PEBLObjectBase::InitializeProperty().

PTextObject() [2/3]

PTextObject::PTextObject

(

const std::string &

text

)

Definition at line 51 of file PTextObject.cpp.

                                              :
    PWidget(0,0,0,0,false),
    mChanged(true),
    mText(std::string(text)),
    mDirection(1)
{
 
    InitializeProperty("TEXT",Variant(mText));
    InitializeProperty("DIRECTION",1);
    InitializeProperty("LINEHEIGHT",0);
}

References PEBLObjectBase::InitializeProperty(), and mText.

PTextObject() [3/3]

PTextObject::PTextObject

(

PTextObject &

object

)

Definition at line 64 of file PTextObject.cpp.

                                            :
    PWidget(0,0,0,0,false),
    mChanged(true),
    mText(object.GetText()),
    mDirection(1)
{
    InitializeProperty("TEXT",Variant(mText));
    InitializeProperty("DIRECTION",1);
    InitializeProperty("LINEHEIGHT",0);
}

References PEBLObjectBase::InitializeProperty(), and mText.

~PTextObject()

PTextObject::~PTextObject ( )

virtual

Definition at line 155 of file PTextObject.cpp.

{
}

Member Function Documentation

GetNumCharacters()

virtual unsigned long int PTextObject::GetNumCharacters ( )

inlinevirtual

Definition at line 58 of file PTextObject.h.

{return mText.length();}

References mText.

GetProperty()

Variant PTextObject::GetProperty ( std::string  name ) const

virtual

Reimplemented from PWidget.

Reimplemented in PlatformTextBox, PLabel, and PTextBox.

Definition at line 122 of file PTextObject.cpp.

{
    return PEBLObjectBase::GetProperty(name);
}

References PEBLObjectBase::GetProperty().

Referenced by PLabel::GetProperty(), and PTextBox::GetProperty().

GetText()

virtual std::string PTextObject::GetText ( ) const

inlinevirtual

Definition at line 56 of file PTextObject.h.

{return mText;}

References mText.

Referenced by PEBLEnvironment::GetInput0(), and PEBLObjects::GetText().

ObjectName()

virtual std::string PTextObject::ObjectName ( ) const

inlineprotectedvirtual

Reimplemented from PWidget.

Reimplemented in PLabel, PTextBox, PlatformLabel, PlatformTextBox, PlatformLabel, and PlatformTextBox.

Definition at line 71 of file PTextObject.h.

{return "PTextObject";};

SendToStream()

virtual std::ostream & PTextObject::SendToStream ( std::ostream &  out ) const

inlineprotectedvirtual

An inheritable printing class used by PEBLObjectBase::operator<<.

Reimplemented from PWidget.

Reimplemented in PLabel, PTextBox, PlatformLabel, PlatformTextBox, PlatformLabel, and PlatformTextBox.

Definition at line 67 of file PTextObject.h.

{return out;};

SetDirection()

void PTextObject::SetDirection ( int  i )

virtual

Definition at line 84 of file PTextObject.cpp.

{
    if(dir ==1 | dir == -1)
        {
            PEBLObjectBase::SetProperty("DIRECTION",Variant(dir));
            mDirection = dir;
            mChanged = true;
        } else 
        {
            PError::SignalFatalError("Improper value for direction");
        }
}

References mChanged, mDirection, PEBLObjectBase::SetProperty(), and PError::SignalFatalError().

Referenced by SetProperty().

SetProperty()

bool PTextObject::SetProperty ( std::string  name, Variant  v  )

virtual

Reimplemented from PWidget.

Reimplemented in PlatformLabel, PlatformTextBox, PLabel, PTextBox, PlatformLabel, and PlatformTextBox.

Definition at line 97 of file PTextObject.cpp.

{
 
 
    if(PWidget::SetProperty(name,v))
        {
            mChanged = true;
            return true;
        }
    else 
        {
            if (name == "TEXT") 
                {
                    SetText(v);
                    return true;
                }
            else if(name == "DIRECTION")
                {
                    SetDirection(v);
                }
            return PWidget::SetProperty(name,v);
        }
}

References mChanged, SetDirection(), PWidget::SetProperty(), and SetText().

Referenced by PLabel::SetProperty(), and PTextBox::SetProperty().

SetText()

void PTextObject::SetText ( const std::string &  text )

virtual

Reimplemented in PlatformLabel.

Definition at line 76 of file PTextObject.cpp.

{
    mText = text; 
    PEBLObjectBase::SetProperty("TEXT",Variant(text));
    mChanged = true;
}

References mChanged, mText, and PEBLObjectBase::SetProperty().

Referenced by PTextBox::SetProperty(), SetProperty(), PlatformLabel::SetText(), and PlatformTextBox::SetText().

ValidateProperty() [1/2]

ObjectValidationError PTextObject::ValidateProperty ( std::string  name ) const

virtual

Reimplemented from PWidget.

Reimplemented in PlatformLabel, PlatformTextBox, PLabel, and PTextBox.

Definition at line 133 of file PTextObject.cpp.

{
 
   ObjectValidationError ove = PWidget::ValidateProperty(name);
    
    if(ove == OVE_VALID)
        return ove;
 
    else if(name == "TEXT" || 
            name == "WIDTH" ||
            name == "HEIGHT" ||
            name == "FONT" ||
            name == "DIRECTION"||
            name == "LINEHEIGHT")
 
        return OVE_VALID;
    else
        return OVE_INVALID_PROPERTY_NAME;
 
}

References OVE_INVALID_PROPERTY_NAME, OVE_VALID, and PWidget::ValidateProperty().

ValidateProperty() [2/2]

ObjectValidationError PTextObject::ValidateProperty ( std::string  name, Variant  v  ) const

virtual

Reimplemented from PWidget.

Reimplemented in PlatformLabel, PlatformTextBox, PLabel, and PTextBox.

Definition at line 128 of file PTextObject.cpp.

{
        return ValidateProperty(name);
}

References ValidateProperty().

Referenced by PLabel::ValidateProperty(), PTextBox::ValidateProperty(), and ValidateProperty().

Member Data Documentation

mChanged

bool PTextObject::mChanged

protected

Definition at line 69 of file PTextObject.h.

Referenced by PTextBox::DeleteText(), PlatformLabel::Draw(), PlatformTextBox::Draw(), PTextBox::InsertText(), PlatformTextBox::PlatformTextBox(), PTextBox::PTextBox(), PlatformTextBox::RenderText(), SetDirection(), PlatformTextBox::SetEditable(), PlatformLabel::SetFont(), PlatformTextBox::SetFont(), PTextBox::SetHeight(), PTextBox::SetJustify(), PTextBox::SetProperty(), SetProperty(), SetText(), PlatformLabel::SetText(), PlatformTextBox::SetText(), and PTextBox::SetWidth().

mDirection

int PTextObject::mDirection

protected

Definition at line 72 of file PTextObject.h.

Referenced by PlatformLabel::RenderText(), and SetDirection().

mText

std::string PTextObject::mText

protected

Definition at line 70 of file PTextObject.h.

Referenced by PTextBox::AtPrintableCharacter(), PTextBox::DecrementCursor(), PTextBox::DeleteText(), PlatformTextBox::FindCursorPosition(), GetNumCharacters(), GetText(), PlatformTextBox::HandleKeyPress(), PTextBox::IncrementCursor(), PTextBox::InsertText(), PlatformTextBox::PlatformTextBox(), PTextObject(), PTextObject(), PlatformLabel::RenderText(), PlatformTextBox::RenderText(), PlatformTextBox::SetEditable(), and SetText().

---

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

• PTextObject.h
• PTextObject.cpp