Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

os::TextView Class Reference

#include <textview.h>

Inheritance diagram for os::TextView:

os::View os::Invoker os::Handler List of all members.

Public Types

typedef std::vector<std::string> buffer_type

Public Methods

 TextView (const Rect &cFrame, const char *pzTitle, const char *pzBuffer, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_FULL_UPDATE_ON_RESIZE)
 ~TextView ()
ViewGetEditor () const
void SetEnable (bool bEnabled=true)
bool IsEnabled () const
void SetMultiLine (bool bMultiLine=true)
bool GetMultiLine ()
void SetPasswordMode (bool bPassword=true)
bool GetPasswordMode () const
void SetNumeric (bool bNumeric)
bool GetNumeric () const
void SetReadOnly (bool bFlag=true)
bool GetReadOnly () const
int GetMaxUndoSize () const
void SetMaxUndoSize (int nSize)
void GetRegion (std::string *pcBuffer)
void SetMinPreferredSize (int nWidthChars, int nHeightChars)
IPoint GetMinPreferredSize () const
void SetMaxPreferredSize (int nWidthChars, int nHeightChars)
IPoint GetMaxPreferredSize () const
void MakeCsrVisible ()
void Clear ()
void Set (const char *pzBuffer)
void Insert (const char *pzBuffer)
void Cut ()
void Copy ()
void Paste ()
void Delete ()
const buffer_typeGetBuffer () const
virtual void SetTabOrder (int nOrder)
 Set the keyboard manouvering sorting order. More...

virtual Point GetPreferredSize (bool bLargest) const
virtual bool FilterKeyStroke (const std::string *pcString)
virtual void FontChanged (Font *pcNewFont)
 Called to notify the view that the font has changed. More...

virtual void FrameSized (const Point &cDelta)
virtual void Paint (const Rect &cUpdateRect)
 Called by the system update "damaged" areas of the view. More...

virtual void KeyDown (const char *pzString, const char *pzRawString, uint32 nQualifiers)

Friends

class  TextEdit

Detailed Description

Description:
See also:
Author(s):
Kurt Skauen (kurt@atheos.cx)


Member Typedef Documentation

typedef std::vector< std::string > os::TextView::buffer_type
 


Constructor & Destructor Documentation

TextView::TextView ( const Rect & cFrame,
const char * pzTitle,
const char * pzText,
uint32 nResizeMask = CF_FOLLOW_LEFT | CF_FOLLOW_TOP,
uint32 nFlags = WID_WILL_DRAW | WID_FULL_UPDATE_ON_RESIZE )
 

TextView::~TextView ( )
 


Member Function Documentation

void TextView::Clear ( )
 

void TextView::Copy ( )
 

void TextView::Cut ( )
 

void TextView::Delete ( )
 

bool TextView::FilterKeyStroke ( const std::string * pcString ) [virtual]
 

void TextView::FontChanged ( Font * pcNewFont ) [virtual]
 

Called to notify the view that the font has changed.

Description:
FontChanged() is a virtual hook function that can be overloaded by inheriting classes to track changes to the view's font.

This hook function is called whenver the font is replaced through the View::SetFont() member or if the currently assigned font is modified in a way that whould alter the graphical appearance of the font.
Note:
View::SetFont() will call FontChanged() syncronously and will cause FontChanged() to be called even if the view is not yet added to a window. Changes done to the font-object cause a message to be sendt to the window thread and FontChanged() will then be called asyncronously from the window thread when the message arrive. For this reason it is only possible to track changes done to the font object itself when the view is added to a window.
Parameters:
pcNewFont   Pointer to the affected font (same as returned by GetFont()).

See also:
SetFont(), os::Font
Author(s):
Kurt Skauen (kurt@atheos.cx)

Reimplemented from os::View.

void TextView::FrameSized ( const Point & cDelta ) [virtual]
 

Reimplemented from os::View.

const TextView::buffer_type & TextView::GetBuffer ( ) const
 

View * TextView::GetEditor ( ) const
 

IPoint TextView::GetMaxPreferredSize ( ) const
 

int TextView::GetMaxUndoSize ( ) const
 

IPoint TextView::GetMinPreferredSize ( ) const
 

bool TextView::GetMultiLine ( )
 

bool TextView::GetNumeric ( ) const
 

bool TextView::GetPasswordMode ( ) const
 

Point TextView::GetPreferredSize ( bool bLargest ) const [virtual]
 

Reimplemented from os::View.

bool TextView::GetReadOnly ( ) const
 

void TextView::GetRegion ( std::string * pcBuffer )
 

void TextView::Insert ( const char * pzBuffer )
 

bool TextView::IsEnabled ( ) const
 

void TextView::KeyDown ( const char * pzString,
const char * pzRawString,
uint32 nQualifiers ) [virtual]
 

Reimplemented from os::View.

void TextView::MakeCsrVisible ( )
 

void TextView::Paint ( const Rect & cUpdateRect ) [virtual]
 

Called by the system update "damaged" areas of the view.

Description:
Note:
Warning:
Parameters:
cUpdateRect   A rectangle enclosing all damaged areas. This is just a rough "worst-case", further fine-grained clipping will be performed by the Application Server to avoid updating non-damaged pixels and make the update as fast and flicker-free as possible.

See also:
Invalidate(), Flush()
Author(s):
Kurt Skauen (kurt@atheos.cx)

Reimplemented from os::View.

void TextView::Paste ( )
 

void TextView::Set ( const char * pzBuffer )
 

void TextView::SetEnable ( bool bEnabled = true )
 

void TextView::SetMaxPreferredSize ( int nWidthChars,
int nHeightChars )
 

void TextView::SetMaxUndoSize ( int nSize )
 

void TextView::SetMinPreferredSize ( int nWidthChars,
int nHeightChars )
 

void TextView::SetMultiLine ( bool bMultiLine = true )
 

void TextView::SetNumeric ( bool bNumeric )
 

void TextView::SetPasswordMode ( bool bPassword = true )
 

void TextView::SetReadOnly ( bool bFlag = true )
 

void TextView::SetTabOrder ( int nOrder ) [virtual]
 

Set the keyboard manouvering sorting order.

Description:
Set the value that will be returned by GetTabOrder().
Parameters:
nOrder   - The sorting order.
See also:
GetTabOrder()
Author(s):
Kurt Skauen (kurt.skauen@c2i.net)

Reimplemented from os::View.


Friends And Related Function Documentation

class TextEdit [friend]
 


The documentation for this class was generated from the following files:
Generated at Sat Apr 7 16:11:43 2001 for AtheOS higlevel API by doxygen1.2.5 written by Dimitri van Heesch, © 1997-2001