VCF::GTKTextControl Class Reference

class GTKTextControl documentation More...

#include <GTKTextControl.h>

Inheritance diagram for VCF::GTKTextControl:


Public Member Functions
	GTKTextControl (TextControl *component, const bool &isMultiLineControl)
virtual	~GTKTextControl ()
virtual void	create (Control *owningControl)
	This is called to actually create any neccessary windowing system resources specific to a new control (or widget/window/etc) instance for the platform.
virtual void	setRightMargin (const double &rightMargin)
virtual void	setLeftMargin (const double &leftMargin)
virtual uint32	getLineCount ()
virtual Rect	getContentBoundsForWidth (const double &width)
virtual uint32	getCurrentLinePosition ()
virtual double	getLeftMargin ()
virtual double	getRightMargin ()
virtual double	getTopMargin ()
virtual double	getBottomMargin ()
virtual Point *	getPositionFromCharIndex (const uint32 &index)
virtual uint32	getCharIndexFromPosition (Point *point)
virtual uint32	getCaretPosition ()
	returns the current caret position with in the text control this is specified by a zero based number representing the insertion point with the text control's text (stored in the text control's Model).
virtual void	setCaretPosition (const uint32 &caretPos)
virtual uint32	getSelectionStart ()
	returns the zero based index that indicates where the current selection begins may be the same index that getCaretPosition() returns
virtual uint32	getSelectionCount ()
	returns the number of characters selected
virtual void	setSelectionMark (const uint32 &start, const uint32 &count)
virtual void	setSelectionFont (Font *font)
virtual void	setParagraphAlignment (const TextAlignmentType &alignment)
virtual void	scrollToLine (const uint32 &lineIndex)
virtual gboolean	handleEvent (GdkEvent *gtkEvent)
virtual String	getText ()
	returns a text associated with the component.
virtual void	setText (const String &text)
	sets the text for the widget
virtual void	scrollToSelection (const bool &showEndSel=false)
virtual void	setReadOnly (const bool &readonly)
virtual void	setBorder (Border *border)
	Called by the control when it's border object changes.
virtual uint32	getTotalPrintablePageCount (PrintContext *context)
virtual void	print (PrintContext *context, const int32 &page)
virtual void	finishPrinting ()
virtual void	repaint (Rect *repaintRect, const bool &immediately)
virtual void	preChildPaint (GraphicsContext graphicsContext, Control child, Rect *childClipRect)
	Called by the container instance of the child's parent control during it's paintChildren() function.
virtual void	postChildPaint (GraphicsContext graphicsContext, Control child, Rect *oldClipRect)
	Called by the container instance of the child's parent control during it's paintChildren() function.
virtual OSHandleID	getTextObjectHandle ()
	Return the native text object handle.
virtual void	insertText (unsigned int start, const String &text)
virtual void	deleteText (unsigned int start, unsigned int length)
virtual unsigned int	getTextLength ()
virtual String	getText (unsigned int start, unsigned int length)
virtual void	paint (GraphicsContext *context, const Rect &paintRect)
virtual void	setTopMargin (const double &topMargin)
virtual void	setBottomMargin (const double &bottomMargin)
virtual void	setStyle (unsigned int start, unsigned int length, Dictionary &styles)
	This sets the style for the text.
virtual void	getStyle (unsigned int start, unsigned int length, VCF::Dictionary &styles)
	gets the current style of the text.
virtual void	setDefaultStyle (Dictionary &styles)
	call this to set the defaults for the text peer.
Protected Member Functions
void	onTextModelTextChanged (TextEvent *e)
Protected Attributes
TextControl *	textControl_
bool	isMultiLineControl_
GtkEntry *	singleLine_
GtkTextView *	multiLine_
bool	internalTextChange_

Detailed Description

class GTKTextControl documentation

Constructor & Destructor Documentation

VCF::GTKTextControl::GTKTextControl ( TextControl * component,

const bool & isMultiLineControl

)

virtual VCF::GTKTextControl::~GTKTextControl ( ) [virtual]

Member Function Documentation

virtual void VCF::GTKTextControl::create ( Control * owningControl ) [virtual]

This is called to actually create any neccessary windowing system resources specific to a new control (or widget/window/etc) instance for the platform.
create() must be called by the containing VCF::Control subclass, typically in the classes constructor, after retreiving the new peer instance from the appropriate UIToolkit::createXXX() call.
Reimplemented from VCF::AbstractGTKControl.

virtual void VCF::GTKTextControl::deleteText ( unsigned int start,

unsigned int length

) [virtual]

Implements VCF::TextPeer.

virtual void VCF::GTKTextControl::finishPrinting ( ) [virtual]

virtual double VCF::GTKTextControl::getBottomMargin ( ) [virtual]

Implements VCF::TextPeer.

virtual uint32 VCF::GTKTextControl::getCaretPosition ( ) [virtual]

returns the current caret position with in the text control this is specified by a zero based number representing the insertion point with the text control's text (stored in the text control's Model).

Returns:
uint32 the index of the current insertion point in the Model's text

virtual uint32 VCF::GTKTextControl::getCharIndexFromPosition ( Point * point ) [virtual]

virtual Rect VCF::GTKTextControl::getContentBoundsForWidth ( const double & width ) [virtual]

Implements VCF::TextPeer.

virtual uint32 VCF::GTKTextControl::getCurrentLinePosition ( ) [virtual]

virtual double VCF::GTKTextControl::getLeftMargin ( ) [virtual]

Implements VCF::TextPeer.

virtual uint32 VCF::GTKTextControl::getLineCount ( ) [virtual]

Implements VCF::TextPeer.

virtual Point* VCF::GTKTextControl::getPositionFromCharIndex ( const uint32 & index ) [virtual]

virtual double VCF::GTKTextControl::getRightMargin ( ) [virtual]

Implements VCF::TextPeer.

virtual uint32 VCF::GTKTextControl::getSelectionCount ( ) [virtual]

returns the number of characters selected

Returns:
uint32 the number of characters selected, a return value of 0 indicates that no characters are currently selected

virtual uint32 VCF::GTKTextControl::getSelectionStart ( ) [virtual]

returns the zero based index that indicates where the current selection begins may be the same index that getCaretPosition() returns

virtual void VCF::GTKTextControl::getStyle ( unsigned int start,

unsigned int length,

VCF::Dictionary & styles

) [virtual]

gets the current style of the text.

Parameters:

unsigned int start the beginning of the location of which we are getting the style.

unsigned int length the length of the location of which we are getting the style.

Dictionary& styles the dictionary storing the values for each style attribute.

Implements VCF::TextPeer.

virtual String VCF::GTKTextControl::getText ( unsigned int start,

unsigned int length

) [virtual]

Implements VCF::TextPeer.

virtual String VCF::GTKTextControl::getText ( ) [virtual]

returns a text associated with the component.
This usually gets used in the Control::getCaption() method.
Reimplemented from VCF::AbstractGTKControl.

virtual unsigned int VCF::GTKTextControl::getTextLength ( ) [virtual]

Implements VCF::TextPeer.

virtual OSHandleID VCF::GTKTextControl::getTextObjectHandle ( ) [virtual]

Return the native text object handle.
For Win32 systems this will be an IUnknown interface that may be queried for either ITextServices or ITextDocument. For OSX this will be a TXNObject instance.
Implements VCF::TextPeer.

virtual double VCF::GTKTextControl::getTopMargin ( ) [virtual]

Implements VCF::TextPeer.

virtual uint32 VCF::GTKTextControl::getTotalPrintablePageCount ( PrintContext * context ) [virtual]

virtual gboolean VCF::GTKTextControl::handleEvent ( GdkEvent * gtkEvent ) [virtual]

Reimplemented from VCF::AbstractGTKControl.

virtual void VCF::GTKTextControl::insertText ( unsigned int start,

const String & text

) [virtual]

Implements VCF::TextPeer.

void VCF::GTKTextControl::onTextModelTextChanged ( TextEvent * e ) [protected]

virtual void VCF::GTKTextControl::paint ( GraphicsContext * context,

const Rect & paintRect

) [virtual]

Implements VCF::TextPeer.

virtual void VCF::GTKTextControl::postChildPaint ( GraphicsContext * graphicsContext,

Control * child,

Rect * oldClipRect

) [virtual]

Called by the container instance of the child's parent control during it's paintChildren() function.
Called after the child control's paint() and paintBorder() functions.
Implements VCF::ControlPeer.

virtual void VCF::GTKTextControl::preChildPaint ( GraphicsContext * graphicsContext,

Control * child,

Rect * childClipRect

) [virtual]

Called by the container instance of the child's parent control during it's paintChildren() function.
The implementation should do whatever is neccessary to seup up the child control's cliprect. A pre-calculated cliprect is passed in that was generated by the paintChildren() function.
This function is called prior the child control's paint() or paintBorder() functions.
Implements VCF::ControlPeer.

virtual void VCF::GTKTextControl::print ( PrintContext * context,

const int32 & page

) [virtual]

virtual void VCF::GTKTextControl::repaint ( Rect * repaintRect,

const bool & immediately

) [virtual]

Implements VCF::ControlPeer.

virtual void VCF::GTKTextControl::scrollToLine ( const uint32 & lineIndex ) [virtual]

virtual void VCF::GTKTextControl::scrollToSelection ( const bool & showEndSel = false ) [virtual]

virtual void VCF::GTKTextControl::setBorder ( Border * border ) [virtual]

Called by the control when it's border object changes.
May or may not need to be implemented depending on the windowing system.
Implements VCF::ControlPeer.

virtual void VCF::GTKTextControl::setBottomMargin ( const double & bottomMargin ) [virtual]

Implements VCF::TextPeer.

virtual void VCF::GTKTextControl::setCaretPosition ( const uint32 & caretPos ) [virtual]

virtual void VCF::GTKTextControl::setDefaultStyle ( Dictionary & styles ) [virtual]

call this to set the defaults for the text peer.
If this is not called, then the default font is that used for label controls and the defaul paragraph alignment is left aligned.
Implements VCF::TextPeer.

virtual void VCF::GTKTextControl::setLeftMargin ( const double & leftMargin ) [virtual]

Implements VCF::TextPeer.

virtual void VCF::GTKTextControl::setParagraphAlignment ( const TextAlignmentType & alignment ) [virtual]

virtual void VCF::GTKTextControl::setReadOnly ( const bool & readonly ) [virtual]

virtual void VCF::GTKTextControl::setRightMargin ( const double & rightMargin ) [virtual]

Implements VCF::TextPeer.

virtual void VCF::GTKTextControl::setSelectionFont ( Font * font ) [virtual]

virtual void VCF::GTKTextControl::setSelectionMark ( const uint32 & start,

const uint32 & count

) [virtual]

virtual void VCF::GTKTextControl::setStyle ( unsigned int start,

unsigned int length,

Dictionary & styles

) [virtual]

This sets the style for the text.
Pass in a Dictionary with a set of values for each style attribute. Example:
TextPeer* textPeer = ....
Dictionary styles; style [Text::fsFontName] = "Arial"; style [Text::fsPointSize] = 15.0; style [Text::fsBold] = true;
textPeer->setStyle( 5, 10, styles );
this changes the font at position 5, for a length of 10, to be "arial", bold and a point size of 15.
Implements VCF::TextPeer.

virtual void VCF::GTKTextControl::setText ( const String & text ) [virtual]

sets the text for the widget

Reimplemented from VCF::AbstractGTKControl.

virtual void VCF::GTKTextControl::setTopMargin ( const double & topMargin ) [virtual]

Implements VCF::TextPeer.

Member Data Documentation

bool VCF::GTKTextControl::internalTextChange_ [protected]

bool VCF::GTKTextControl::isMultiLineControl_ [protected]

GtkTextView* VCF::GTKTextControl::multiLine_ [protected]

GtkEntry* VCF::GTKTextControl::singleLine_ [protected]

TextControl* VCF::GTKTextControl::textControl_ [protected]

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

vcf/ApplicationKit/GTKTextControl.h

VCF::GTKTextControl Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation