GEdit Class Reference

An edit box allowing the user to enter text. More...

#include <GEdit.h>

Inheritance diagram for GEdit:

GTextView3 GDocView GDragDropTarget GLayout GView

List of all members.

Public Member Functions

 GEdit (int id, int x, int y, int cx, int cy, const char *name)
 Constructor.
const char * GetClass ()
bool MultiLine ()
 Gets "Allow multiple lines".
void MultiLine (bool m)
 Sets "Allow multiple lines".
bool Password ()
 Is the text obsured by hashes?
void Password (bool m)
 Sets the text to be obsured by hashes.
void Value (int64 i)
 Interprets the text in the control as an integer.
int64 Value ()
 Sets the text in the control to an integer.
void Select (int Start=0, int Len=-1)
 Selects a region of text.
bool GetSelection (int &Start, int &Len)
 Get the current selection in characters.
int GetCaret ()
 Gets the Caret position in characters.
void SetCaret (int Pos)
 Sets the Caret position in characters.
bool OnKey (GKey &k)
 A key was pressed while this view has focus.
void OnEnter (GKey &k)
 Called when the user hits the enter key.
void SendNotify (int Data)
 Sends a notification to the notify target or the parent chain.
bool OnLayout (GViewLayoutInfo &Inf)
 Called to get layout information for the control.


Detailed Description

An edit box allowing the user to enter text.

Constructor & Destructor Documentation

GEdit::GEdit ( int  id,
int  x,
int  y,
int  cx,
int  cy,
const char *  name 
)

Constructor.

Parameters:
id  Ctrl's ID
x  x coord
y  y coord
cx  width
cy  height
name  Initial text

References GTextView3::Name(), GView::SetPos(), GTextView3::SetWrapType(), GView::Sunken(), SysFont, TEXTED_WRAP_NONE, GDisplayString::X(), and GDisplayString::Y().


Member Function Documentation

const char* GEdit::GetClass (  )  [inline]

The class' name. Should be overriden in child classes to return the right class name. Mostly used for debugging, but in the win32 port it is also the default WIN32 class name passed to RegisterClass() in GView::CreateClass().

Returns:
the Class' name for debugging

Reimplemented from GTextView3.


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

Generated on Wed May 11 07:51:57 2011 for Lgi by  doxygen 1.5.6