Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   
VCF::TextEditPeer

VCF::TextEditPeer Class Reference

A interface for supporting text controls This results in a native text control widget being created, with all painting responsibilities being controlled by the native widget. More...

#include <vcf/ApplicationKit/TextPeer.h>

Inheritance diagram for VCF::TextEditPeer:

VCF::TextPeer VCF::Interface VCF::OSXTextEditPeer VCF::Win32Edit List of all members.

Public Member Functions

virtual Point * getPositionFromCharIndex (const uint32 &index)=0
virtual uint32 getCharIndexFromPosition (Point *point)=0
virtual uint32 getCaretPosition ()=0
 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)=0
virtual uint32 getCurrentLinePosition ()=0
virtual uint32 getSelectionStart ()=0
 returns the zero based index that indicates where the current selection begins may be the same index that getCaretPosition() returns
virtual uint32 getSelectionCount ()=0
 returns the number of characters selected
virtual void setSelectionMark (const uint32 &start, const uint32 &count)=0
virtual void clearSelection ()=0
virtual void scrollToLine (const uint32 &lineIndex)=0
virtual void scrollToSelection (const bool &showEndSel=false)=0
virtual void setReadOnly (const bool &readonly)=0
virtual void cut ()=0
 Cuts the selection and places it in the clipboard.
virtual void copy ()=0
 Copies the selection and places it in the clipboard.
virtual void paste ()=0
 Pastes the contents of the clipboard into the text control.
virtual bool canUndo ()=0
 Returns a bool to indicate whether or not an undo operation can be performed.
virtual bool canRedo ()=0
 Returns a bool to indicate whether or not a redo operation can be performed.
virtual void undo ()=0
 Undoes the last operation.
virtual void redo ()=0
 Redoes the last operation.
virtual uint32 getTotalPrintablePageCount (PrintContext *context)=0
virtual void print (PrintContext *context, const int32 &page)=0
 This attempts to print a single page and render in to the printer context that's passed in.
virtual void finishPrinting ()=0
virtual void setTextWrapping (const bool &val)=0
virtual bool getTextWrapping ()=0

Detailed Description

A interface for supporting text controls This results in a native text control widget being created, with all painting responsibilities being controlled by the native widget.

Member Function Documentation

virtual bool VCF::TextEditPeer::canRedo (   )  [pure virtual]
 

Returns a bool to indicate whether or not a redo operation can be performed.

Returns:
bool true if an a redo operation can be performed. This indicates that a call to redo() will succeed. Returns false to indicate no redo is possible and any calls to redo() will be no-ops.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual bool VCF::TextEditPeer::canUndo (   )  [pure virtual]
 

Returns a bool to indicate whether or not an undo operation can be performed.

Returns:
bool true if an an undo operation can be performed. This indicates that a call to undo() will succeed. Returns false to indicate no undo is possible and any calls to undo() will be no-ops.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::clearSelection (   )  [pure virtual]
 

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::copy (   )  [pure virtual]
 

Copies the selection and places it in the clipboard.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::cut (   )  [pure virtual]
 

Cuts the selection and places it in the clipboard.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::finishPrinting (   )  [pure virtual]
 

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual uint32 VCF::TextEditPeer::getCaretPosition (   )  [pure 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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual uint32 VCF::TextEditPeer::getCurrentLinePosition (   )  [pure virtual]
 

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual uint32 VCF::TextEditPeer::getSelectionCount (   )  [pure 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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual uint32 VCF::TextEditPeer::getSelectionStart (   )  [pure virtual]
 

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual bool VCF::TextEditPeer::getTextWrapping (   )  [pure virtual]
 

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::paste (   )  [pure virtual]
 

Pastes the contents of the clipboard into the text control.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::print (  PrintContext *  context,
const int32 &  page
)  [pure virtual]
 

This attempts to print a single page and render in to the printer context that's passed in.

Note that some platforms may not support this, as printing support varies widely. It will work on Win32, and should work on Mac OS X as well.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::redo (   )  [pure virtual]
 

Redoes the last operation.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

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

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::setSelectionMark (  const uint32 &  start,
const uint32 &  count
)  [pure virtual]
 

Parameters:
uint32 the starting point. The index is zero based.
uint32 the number of characters selected.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::setTextWrapping (  const bool &  val  )  [pure virtual]
 

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

virtual void VCF::TextEditPeer::undo (   )  [pure virtual]
 

Undoes the last operation.

Implemented in VCF::OSXTextEditPeer, and VCF::Win32Edit.

The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information