PG_MultiLineEdit Class Reference

#include <pgmultilineedit.h>

Inheritance diagram for PG_MultiLineEdit:

[legend]List of all members.

Public Member Functions
	PG_MultiLineEdit (PG_Widget *parent, const PG_Rect &r, const std::string &style="LineEdit", int maximumLength=1000000)
virtual void	SetText (const std::string &new_text)
	Set the current text string.
void	SetCursorPos (int p)
void	SetVPosition (int line)
void	InsertText (const std::string &c)
Protected Member Functions
void	eventBlit (SDL_Surface *surface, const PG_Rect &src, const PG_Rect &dst)
	overridable eventhandler to blit the widget contents to the screen
bool	eventKeyDown (const SDL_KeyboardEvent *key)
	Overridable Eventhandler for a SDL_KeyboardEvent message.
bool	eventMouseButtonDown (const SDL_MouseButtonEvent *button)
	Overridable Eventhandler for a SDL_MouseButtonEvent message.
bool	eventMouseMotion (const SDL_MouseMotionEvent *motion)
	Overridable Eventhandler for a SDL_MouseMotionEvent message.
bool	eventMouseButtonUp (const SDL_MouseButtonEvent *button)
	Overridable Eventhandler for a SDL_MouseButtonEvent message.
virtual void	InsertChar (const PG_Char &c)
virtual void	DeleteChar (Uint16 pos)
bool	handleScroll (PG_ScrollBar *widget, long data)

---

Constructor & Destructor Documentation

PG_MultiLineEdit::PG_MultiLineEdit (  PG_Widget *  parent, const PG_Rect &  r, const std::string &  style = "LineEdit", int  maximumLength = 1000000 )

Definition at line 7 of file pgmultilineedit.cpp. References handleScroll(), PG_Widget::Hide(), PG_Widget::MoveWidget(), PG_Rect::PG_Rect(), PG_ScrollBar::sigScrollPos, and PG_ScrollBar::sigScrollTrack.

---

Member Function Documentation

void PG_MultiLineEdit::DeleteChar (  Uint16  pos  )  [protected, virtual]

Reimplemented from PG_LineEdit. Definition at line 623 of file pgmultilineedit.cpp. References PG_LineEdit::DeleteChar(), and PG_LineEdit::my_cursorPosition.

void PG_MultiLineEdit::eventBlit (  SDL_Surface *  surface, const PG_Rect &  src, const PG_Rect &  dst )  [protected, virtual]

overridable eventhandler to blit the widget contents to the screen Parameters: surface  pointer to SDL_Surface to be blitted src  source rectangle (client coordinates) dst  destination rectangle (screen coordinates) Override this eventhandler to perform custom blitting behaviour (without drawing onto the widget surface). Reimplemented from PG_LineEdit. Definition at line 44 of file pgmultilineedit.cpp. References PG_ThemeWidget::eventBlit().

bool PG_MultiLineEdit::eventKeyDown (  const SDL_KeyboardEvent *  key  )  [protected, virtual]

Overridable Eventhandler for a SDL_KeyboardEvent message. This handler is called when a key changed it's state from unpressed to pressed. The default implementation returns 'false' which indicates that this message is not processed by this object. Parameters: key  SDL_KeyboardEvent message Returns: Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver. Reimplemented from PG_LineEdit. Definition at line 368 of file pgmultilineedit.cpp. References PG_LineEdit::eventKeyDown(), PG_LineEdit::GetCursorPos(), PG_Widget::GetFontHeight(), InsertChar(), PG_LineEdit::IsCursorVisible(), PG_LineEdit::my_cursorPosition, PG_Rect::my_height, PG_Widget::my_text, PG_Rect::my_xpos, PG_Rect::my_ypos, PG_Char, PG_LineEdit::SetCursorPos(), SetCursorPos(), SetVPosition(), and PG_Application::TranslateNumpadKeys().

bool PG_MultiLineEdit::eventMouseButtonDown (  const SDL_MouseButtonEvent *  button  )  [protected, virtual]

Overridable Eventhandler for a SDL_MouseButtonEvent message. This handler is called when a mouse button is pressed. The default implementation returns 'false' which indicates that this message is not processed by this object. Parameters: button  SDL_MouseButtonEvent message Returns: Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver. Reimplemented from PG_MessageObject. Definition at line 515 of file pgmultilineedit.cpp. References PG_LineEdit::EditBegin(), PG_LineEdit::GetEditable(), PG_LineEdit::IsCursorVisible(), PG_Widget::IsVisible(), PG_LineEdit::my_cursorPosition, PG_Rect::my_width, PG_Rect::my_xpos, and SetVPosition().

bool PG_MultiLineEdit::eventMouseButtonUp (  const SDL_MouseButtonEvent *  button  )  [protected, virtual]

Overridable Eventhandler for a SDL_MouseButtonEvent message. This handler is called when a mouse button is released. The default implementation returns 'false' which indicates that this message is not processed by this object. Parameters: button  SDL_MouseButtonEvent message Returns: Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver. Reimplemented from PG_LineEdit. Definition at line 567 of file pgmultilineedit.cpp.

bool PG_MultiLineEdit::eventMouseMotion (  const SDL_MouseMotionEvent *  motion  )  [protected, virtual]

Overridable Eventhandler for a SDL_MouseMotionEvent message. This handler is called when mouse movement is detected. The default implementation returns 'false' which indicates that this message is not processed by this object. Parameters: motion  SDL_MouseMotionEvent message Returns: Notifies the message pump if this message is processed by this object or it should be routed to the next message receiver. Reimplemented from PG_MessageObject. Definition at line 557 of file pgmultilineedit.cpp. References PG_MessageObject::eventMouseMotion().

bool PG_MultiLineEdit::handleScroll (  PG_ScrollBar *  widget, long  data )  [protected]

Definition at line 20 of file pgmultilineedit.cpp. References PG_ScrollBar::GetPosition(), and SetVPosition(). Referenced by PG_MultiLineEdit().

void PG_MultiLineEdit::InsertChar (  const PG_Char &  c  )  [protected, virtual]

Reimplemented from PG_LineEdit. Definition at line 616 of file pgmultilineedit.cpp. References InsertText(). Referenced by eventKeyDown().

void PG_MultiLineEdit::InsertText (  const std::string &  c  )

Definition at line 601 of file pgmultilineedit.cpp. References PG_Application::BulkModeActivator::disable(), PG_LineEdit::InsertChar(), PG_LineEdit::my_cursorPosition, and PG_Widget::Update(). Referenced by InsertChar().

void PG_MultiLineEdit::SetCursorPos (  int  p  )  [virtual]

Reimplemented from PG_LineEdit. Definition at line 594 of file pgmultilineedit.cpp. References PG_LineEdit::SetCursorPos(). Referenced by eventKeyDown().

void PG_MultiLineEdit::SetText (  const std::string &  new_text  )  [virtual]

Set the current text string. Parameters: new_text  pointer to text string Reimplemented from PG_LineEdit. Definition at line 653 of file pgmultilineedit.cpp. References PG_LineEdit::SetText(), and SetVPosition(). Referenced by MultiLineEditorDialog::MultiLineEditorDialog(), and NewMessage::NewMessage().

void PG_MultiLineEdit::SetVPosition (  int  line  )

Definition at line 26 of file pgmultilineedit.cpp. References PG_ScrollBar::GetMaxRange(), PG_ScrollBar::GetPosition(), PG_ScrollBar::SetPosition(), and PG_Widget::Update(). Referenced by eventKeyDown(), eventMouseButtonDown(), handleScroll(), and SetText().

---

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

• pgmultilineedit.h
• pgmultilineedit.cpp

---