This class is the basic generic text box. More...

#include <PTextBox.h>

Inheritance diagram for PTextBox:

Public Member Functions
	PTextBox ()

	PTextBox (std::string text, int width, int height)

	PTextBox (PTextBox &textbox)

virtual	~PTextBox ()

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	SetHeight (int h)

virtual void	SetWidth (int w)

virtual void	InsertText (const std::string character)

virtual void	DeleteText (int length)

virtual void	SetEditable (bool val)

virtual bool	GetEditable ()

virtual void	SetCursorPosition (unsigned long int pos)

virtual unsigned long int	GetCursorPosition ()

virtual long unsigned int	IncrementCursor ()

virtual long unsigned int	DecrementCursor ()

virtual void	SetLineWrap (bool state)

virtual void	SetJustify (Variant j)

virtual void	HandleKeyPress (int keycode, int modkeys, Uint16 unicode)

virtual void	HandleTextInput (std::string text)

virtual bool	AtPrintableCharacter (unsigned long int x)

virtual std::string	ObjectName () const

Public Member Functions inherited from PTextObject
	PTextObject ()

	PTextObject (const std::string &text)

	PTextObject (PTextObject &object)

virtual	~PTextObject ()

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<<.

Protected Attributes
bool	mEditable

unsigned long int	mCursorPos

bool	mCursorChanged

bool	mLineWrap

Variant	mJustify

Protected Attributes inherited from PTextObject
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 is the basic generic text box.

Definition at line 39 of file PTextBox.h.

Constructor & Destructor Documentation

◆ PTextBox() [1/3]

PTextBox::PTextBox ( )

Definition at line 43 of file PTextBox.cpp.

                  :
    PTextObject(""),
    mEditable(false),
    mCursorPos(0),
    mCursorChanged(true),
    mLineWrap(true),
    mJustify(1)
{
    InitializeProperty("TEXT",Variant(""));
    InitializeProperty("WIDTH",Variant(0));
    InitializeProperty("HEIGHT",Variant(0));
    InitializeProperty("EDITABLE",Variant(false));
    InitializeProperty("CURSORPOS",Variant(0));
    InitializeProperty("NAME",Variant("<TEXTBOX>"));
    InitializeProperty("LINEWRAP",Variant(1));
    InitializeProperty("LINEHEIGHT",Variant(0));
    InitializeProperty("NUMTEXTLINES",Variant(0));
    InitializeProperty("TEXTCOMPLETE",Variant(0));
    InitializeProperty("JUSTIFY",Variant("LEFT"));
    InitializeProperty("ISADAPTIVE",Variant(false));
    InitializeProperty("ADAPTIVEMODE",Variant("scalefont"));
    InitializeProperty("REQUESTEDFONTSIZE",Variant(0));
    InitializeProperty("FORMATTED",Variant(0));
}

References PEBLObjectBase::InitializeProperty().

◆ PTextBox() [2/3]

PTextBox::PTextBox	(	std::string	text,
		int	width,
		int	height
	)

Definition at line 70 of file PTextBox.cpp.

                                                       :
    PTextObject(text),
    mEditable(false),
    mCursorPos(0),
    mCursorChanged(true),
    mLineWrap(true),
    mJustify(1)
{
    InitializeProperty("TEXT",Variant(text));
    InitializeProperty("WIDTH",Variant(width));
    InitializeProperty("HEIGHT",Variant(height));
    InitializeProperty("EDITABLE",Variant(false));
    InitializeProperty("CURSORPOS",Variant(0));
    InitializeProperty("NAME",Variant("<TEXTBOX>"));
    InitializeProperty("LINEWRAP",Variant(1));
    InitializeProperty("LINEHEIGHT",Variant(0));
    InitializeProperty("NUMTEXTLINES",Variant(0));
    InitializeProperty("TEXTCOMPLETE",Variant(0));
    InitializeProperty("JUSTIFY",Variant("LEFT"));
    InitializeProperty("ISADAPTIVE",Variant(false));
    InitializeProperty("ADAPTIVEMODE",Variant("scalefont"));
    InitializeProperty("REQUESTEDFONTSIZE",Variant(0));
    InitializeProperty("FORMATTED",Variant(0));
}

References PEBLObjectBase::InitializeProperty().

◆ PTextBox() [3/3]

PTextBox::PTextBox ( PTextBox & textbox )

Definition at line 96 of file PTextBox.cpp.

                                  :
    PTextObject(text.GetText()),
    mEditable(false),
    mCursorPos(0),
    mCursorChanged(true),
    mLineWrap(true),
    mJustify(1)
{
    mChanged = true;
    InitializeProperty("NAME",Variant("<TEXTBOX>"));
    InitializeProperty("LINEWRAP",Variant(1));
    InitializeProperty("LINEHEIGHT",Variant(0));
    InitializeProperty("NUMTEXTLINES",Variant(0));
    InitializeProperty("TEXTCOMPLETE",Variant(0));
    InitializeProperty("JUSTIFY",Variant("LEFT"));
    InitializeProperty("ISADAPTIVE",Variant(false));
    InitializeProperty("ADAPTIVEMODE",Variant("scalefont"));
    InitializeProperty("REQUESTEDFONTSIZE",Variant(0));
    InitializeProperty("FORMATTED",Variant(0));
}

References PEBLObjectBase::InitializeProperty(), and PTextObject::mChanged.

◆ ~PTextBox()

PTextBox::~PTextBox ( )

virtual

Definition at line 117 of file PTextBox.cpp.

118{

119}

Member Function Documentation

◆ AtPrintableCharacter()

bool PTextBox::AtPrintableCharacter ( unsigned long int x )

virtual

Definition at line 424 of file PTextBox.cpp.

{
    unsigned long int pos=x;
 
    if(x> mText.length())
        pos = mText.length();
 
    if (mText[pos] == 10
        || mText[pos] == 13
        || mText[pos] == 18
        )
        return false;
    else
        return true;
}

References PTextObject::mText.

Referenced by PlatformTextBox::FindCursorPosition().

◆ DecrementCursor()

long unsigned int PTextBox::DecrementCursor ( )

virtual

Definition at line 334 of file PTextBox.cpp.

{
 
    
    if(mCursorPos>=1)
        {
            
 
            bool cont = true;
            std::string::iterator start = mText.begin()+mCursorPos;
            std::string::iterator end = start;
            mCursorPos--;
            start--;
            while(!utf8::is_valid(start,end))
                {
                    mCursorPos -= 1;
                    start--;
                }
 
        }
 
    
//    if(AtPrintableCharacter(mCursorPos -1))
//        mCursorPos --;
//    else
//        mCursorPos -= 1;
 
    mCursorChanged = true;
    return mCursorPos;
}

References mCursorChanged, mCursorPos, and PTextObject::mText.

Referenced by PlatformTextBox::HandleKeyPress().

◆ DeleteText()

void PTextBox::DeleteText ( int length )

virtual

Definition at line 210 of file PTextBox.cpp.

{
 
    int count = 0;
    int bytecount = 1;
 
    if(length > 0)
        {
 
            std::string::iterator start = mText.begin();
            std::string::iterator end = start+mCursorPos+1;
 
            while(count < length)
                {
                    
                    while(!utf8::is_valid(start,end) && end < mText.end())
                        {
 
                            end++;
                            bytecount++;
                        }
                    count++;
                    bytecount++;
                    }
 
            //We need to watch deleting at the end. If we try to bite off too much at
            //the end, just don't do it.
            if(bytecount+mCursorPos<mText.length())
                {    
                    mText.erase(mCursorPos, bytecount-1);
                    mChanged= true;
                }
        }
    else if (length < 0)
        {
 
            //Delete before the cursor.
            std::string::iterator start = mText.begin();
            std::string::iterator end = start+mCursorPos-1;
 
 
            //Delete before the cursor.
            while(count < (-length))
                {
 
                    //crash happens here when deleting from the beginning
 
 
 
                    while(!utf8::is_valid(start,end) && start < end)
                        {
 
                            bytecount++;
                            end--;   //delete backward to the end of the remaining
                            
                        }
                    count++;
                    bytecount++;
                }
            
            
            bytecount--; //back off one byte because it got double-incremented
 
 
            if((int)mCursorPos - bytecount < 0)
                {
 
                    mText.erase(0,mCursorPos);
                    mChanged= true;
                    mCursorPos = 0;
 
                }
            else
                {
 
                    mText.erase(mCursorPos-bytecount, bytecount);
                    mChanged= true;
                    mCursorPos -= bytecount;
 
                }
        }
 
    SetProperty("TEXT",mText);
}

References count, PTextObject::mChanged, mCursorPos, PTextObject::mText, and SetProperty().

Referenced by PlatformTextBox::HandleKeyPress().

◆ GetCursorPosition()

virtual unsigned long int PTextBox::GetCursorPosition ( )

inlinevirtual

Definition at line 65 of file PTextBox.h.

65{return mCursorPos;};

References mCursorPos.

◆ GetEditable()

virtual bool PTextBox::GetEditable ( )

inlinevirtual

Definition at line 62 of file PTextBox.h.

62{return mEditable;};

References mEditable.

◆ GetProperty()

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

virtual

Reimplemented from PTextObject.

Reimplemented in PlatformTextBox.

Definition at line 154 of file PTextBox.cpp.

{
    return PTextObject::GetProperty(name);
}

References PTextObject::GetProperty().

Referenced by PlatformTextBox::GetProperty().

◆ HandleKeyPress()

void PTextBox::HandleKeyPress	(	int	keycode,
		int	modkeys,
		Uint16	unicode
	)

virtual

Reimplemented in PlatformTextBox.

Definition at line 394 of file PTextBox.cpp.

{
 
    //First, handle special keys
    switch(keycode)
        {
#if 0
            if(0)
                {
                    InsertText(PEBLUtility::TranslateKeycode(PEBL_Keycode(keycode), modkeys));
                }
#endif
            break;
        }
    mCursorChanged=true;
}

References InsertText(), mCursorChanged, and PEBLUtility::TranslateKeycode().

◆ HandleTextInput()

void PTextBox::HandleTextInput ( std::string text )

virtual

Reimplemented in PlatformTextBox.

Definition at line 414 of file PTextBox.cpp.

{
 
 
    InsertText(text);
    //we may need to adjust cursor position.
    mCursorChanged=true;
}

References InsertText(), and mCursorChanged.

Referenced by PlatformTextBox::HandleTextInput().

◆ IncrementCursor()

long unsigned int PTextBox::IncrementCursor ( )

virtual

AtPrintableCharacter(mCursorPos))

Definition at line 295 of file PTextBox.cpp.

{
 
    
    //this just checks for end-of-line stuff.
    if(0)
        {
            mCursorPos ++;
        }
    else
        {
            
            
            if(mCursorPos > (int)(mText.length()))
                mCursorPos = mText.length();
            
 
 
            bool cont = true;
            std::string::iterator start = mText.begin()+mCursorPos;
            std::string::iterator end = start+1;
            mCursorPos++;
            
            while(!utf8::is_valid(start,end))
                {
 
                    mCursorPos += 1;
                    end++;
                }
 
        }
 
 
            mCursorChanged = true;
 
 
   return mCursorPos;
}

References mCursorChanged, mCursorPos, and PTextObject::mText.

Referenced by PlatformTextBox::HandleKeyPress().

◆ InsertText()

void PTextBox::InsertText ( const std::string character )

virtual

Definition at line 189 of file PTextBox.cpp.

{
 
    
    if(mCursorPos>mText.length())
        mCursorPos=mText.length();
 
    mText.insert(mCursorPos, text);
    mCursorPos += text.length();
 
    mChanged= true;
    mCursorChanged = true;
    SetProperty("TEXT",mText);
 
}

References PTextObject::mChanged, mCursorChanged, mCursorPos, PTextObject::mText, and SetProperty().

Referenced by HandleKeyPress(), PlatformTextBox::HandleKeyPress(), and HandleTextInput().

◆ ObjectName()

std::string PTextBox::ObjectName ( ) const

virtual

Reimplemented from PTextObject.

Reimplemented in PlatformTextBox, and PlatformTextBox.

Definition at line 441 of file PTextBox.cpp.

{
    return "TextBox";
}

◆ SendToStream()

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

inlineprotectedvirtual

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

Reimplemented from PTextObject.

Reimplemented in PlatformTextBox, and PlatformTextBox.

Definition at line 87 of file PTextBox.h.

87{return out;};

◆ SetCursorPosition()

virtual void PTextBox::SetCursorPosition ( unsigned long int pos )

inlinevirtual

Definition at line 64 of file PTextBox.h.

64{mCursorChanged = true; mCursorPos = pos;};

References mCursorChanged, and mCursorPos.

Referenced by SetProperty().

◆ SetEditable()

virtual void PTextBox::SetEditable ( bool val )

inlinevirtual

Reimplemented in PlatformTextBox.

Definition at line 61 of file PTextBox.h.

61{mEditable = val; mCursorChanged=true;};

References mCursorChanged, and mEditable.

Referenced by PlatformTextBox::SetEditable(), and SetProperty().

◆ SetHeight()

void PTextBox::SetHeight ( int h )

virtual

Reimplemented in PlatformTextBox.

Definition at line 367 of file PTextBox.cpp.

{
    mHeight = h;
    mChanged = true;
}

References PTextObject::mChanged, and PWidget::mHeight.

Referenced by PlatformTextBox::SetHeight(), and SetProperty().

◆ SetJustify()

void PTextBox::SetJustify ( Variant j )

virtual

Definition at line 386 of file PTextBox.cpp.

{
 
    mJustify =j;
    mChanged = true;
}

References PTextObject::mChanged, and mJustify.

Referenced by SetProperty().

◆ SetLineWrap()

void PTextBox::SetLineWrap ( bool state )

virtual

Definition at line 380 of file PTextBox.cpp.

{
    mLineWrap = state;
}

References mLineWrap.

Referenced by SetProperty().

◆ SetProperty()

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

virtual

Reimplemented from PTextObject.

Reimplemented in PlatformTextBox, and PlatformTextBox.

Definition at line 124 of file PTextBox.cpp.

{
 
    if(PTextObject::SetProperty(name,v))
    {
        // If we set it at higher level, don't worry.
    }
    else if(name =="WIDTH")   SetWidth(v);
    else if(name == "HEIGHT") SetHeight(v);
    else if(name == "TEXT"){
        SetText(v.GetString());
        mCursorChanged=true;
        mChanged=true;}
    else if(name == "EDITABLE")SetEditable(v);
    else if(name == "CURSORPOS") SetCursorPosition(v);
    else if(name == "LINEWRAP") SetLineWrap(v);
    else if(name == "JUSTIFY") SetJustify(v);
    else if(name == "ISADAPTIVE" || name == "ADAPTIVEMODE" || name == "REQUESTEDFONTSIZE" || name == "FORMATTED") {
        // These properties are stored only in the property system
        // Adaptive scaling is handled in PEBL code (UI.pbl)
        // Formatted text rendering is handled in PlatformTextBox
        // Store the property value and mark as changed
        PEBLObjectBase::SetProperty(name, v);
        mChanged = true;
    }
    else return false;
    return true;
}

References Variant::GetString(), PTextObject::mChanged, mCursorChanged, SetCursorPosition(), SetEditable(), SetHeight(), SetJustify(), SetLineWrap(), PEBLObjectBase::SetProperty(), PTextObject::SetProperty(), PTextObject::SetText(), and SetWidth().

Referenced by DeleteText(), InsertText(), PlatformTextBox::SetProperty(), and PlatformTextBox::SetProperty().

◆ SetWidth()

void PTextBox::SetWidth ( int w )

virtual

Reimplemented in PlatformTextBox.

Definition at line 373 of file PTextBox.cpp.

{
    mWidth = w;
    mChanged = true;
}

References PTextObject::mChanged, and PWidget::mWidth.

Referenced by SetProperty(), and PlatformTextBox::SetWidth().

◆ ValidateProperty() [1/2]

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

virtual

Reimplemented from PTextObject.

Reimplemented in PlatformTextBox.

Definition at line 176 of file PTextBox.cpp.

{
    if(name == "CURSORPOS"| name=="LINEWRAP"| name == "JUSTIFY" | name == "NUMTEXTLINES" | name == "TEXTCOMPLETE" | name == "ISADAPTIVE" | name == "ADAPTIVEMODE" | name == "REQUESTEDFONTSIZE" | name == "FORMATTED")
        return OVE_VALID;
    else
        return PTextObject::ValidateProperty(name);
}

References OVE_VALID, and PTextObject::ValidateProperty().

◆ ValidateProperty() [2/2]

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

virtual

Reimplemented from PTextObject.

Reimplemented in PlatformTextBox.

Definition at line 160 of file PTextBox.cpp.

{
 
    if(name == "JUSTIFY")
        {
            if(v=="LEFT" | v == "RIGHT" | v == "CENTER")
                {
                    return OVE_VALID;
                }else
                {
                    return OVE_INVALID_PROPERTY_VALUE;
                }
        }
    return ValidateProperty(name);
}

References OVE_INVALID_PROPERTY_VALUE, OVE_VALID, and ValidateProperty().

Referenced by PlatformTextBox::ValidateProperty(), PlatformTextBox::ValidateProperty(), and ValidateProperty().

Member Data Documentation

◆ mCursorChanged

bool PTextBox::mCursorChanged

protected

Definition at line 92 of file PTextBox.h.

Referenced by DecrementCursor(), PlatformTextBox::Draw(), HandleKeyPress(), PlatformTextBox::HandleKeyPress(), HandleTextInput(), IncrementCursor(), InsertText(), SetCursorPosition(), SetEditable(), PlatformTextBox::SetEditable(), SetProperty(), and PlatformTextBox::SetText().

◆ mCursorPos

unsigned long int PTextBox::mCursorPos

protected

Definition at line 91 of file PTextBox.h.

Referenced by DecrementCursor(), DeleteText(), GetCursorPosition(), PlatformTextBox::HandleKeyPress(), IncrementCursor(), InsertText(), SetCursorPosition(), and PlatformTextBox::SetEditable().

◆ mEditable

bool PTextBox::mEditable

protected

Definition at line 90 of file PTextBox.h.

Referenced by PlatformTextBox::Draw(), GetEditable(), PlatformTextBox::RenderText(), and SetEditable().

◆ mJustify

Variant PTextBox::mJustify

protected

Definition at line 94 of file PTextBox.h.

Referenced by PlatformTextBox::FindCursorPosition(), PlatformTextBox::HandleKeyPress(), PlatformTextBox::RenderText(), and SetJustify().

◆ mLineWrap

bool PTextBox::mLineWrap

protected

Definition at line 93 of file PTextBox.h.

Referenced by SetLineWrap().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PTextBox() [1/3]

◆ PTextBox() [2/3]

◆ PTextBox() [3/3]

◆ ~PTextBox()

Member Function Documentation

◆ AtPrintableCharacter()

◆ DecrementCursor()

◆ DeleteText()

◆ GetCursorPosition()

◆ GetEditable()

◆ GetProperty()

◆ HandleKeyPress()

◆ HandleTextInput()

◆ IncrementCursor()

◆ InsertText()

◆ ObjectName()

◆ SendToStream()

◆ SetCursorPosition()

◆ SetEditable()

◆ SetHeight()

◆ SetJustify()

◆ SetLineWrap()

◆ SetProperty()

◆ SetWidth()

◆ ValidateProperty() [1/2]

◆ ValidateProperty() [2/2]

Member Data Documentation

◆ mCursorChanged

◆ mCursorPos

◆ mEditable

◆ mJustify

◆ mLineWrap