Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

VDKTextView Class Reference

Provides a gtk+ gtktextview wrapper. This widget works under a buffer-view model, text buffer take care of changes and text view of displaying. Any change to text buffer will reflect automagically into text view. This widget substitutes old VDKText used on vdkbuilder version <= 1.2.5 and now deprecated even if will remain in use on earlier versions of VDK 2.0 series. More...

#include <vdktextview.h>

Inheritance diagram for VDKTextView:

VDKObjectContainer VDKObject VDKNotCopyAble List of all members.

Public Methods

Public Attributes


Detailed Description

Provides a gtk+ gtktextview wrapper. This widget works under a buffer-view model, text buffer take care of changes and text view of displaying. Any change to text buffer will reflect automagically into text view. This widget substitutes old VDKText used on vdkbuilder version <= 1.2.5 and now deprecated even if will remain in use on earlier versions of VDK 2.0 series.


Constructor & Destructor Documentation

VDKTextView::VDKTextView VDKForm   owner,
VDKTextBuffer   buffer = NULL,
int    left_border = 0
 

Constructor

Parameters:
owner 
buffer  NULL widget will make his own buffer, otherwise will share <buffer>
left_border  if greater than 0 a left window will be made with <left_border> size
tip
left_border should be greater than zero if user wants activate ShowLineNumbers property.

VDKTextView::~VDKTextView   [virtual]
 

Destructor


Member Function Documentation

void VDKTextView::BackwardDelete int    nchars [inline]
 

Backward delete chars from insertion point

VDKTextBuffer * VDKTextView::Buffer VDKTextBuffer   buff = NULL
 

Sets/Gets text buffer. Several text views can share same text buffer:

  VDKTextBuffer* textbuff = new VDKTextBuffer();
  VDKTextView view = new VDKTextView(this,textbuff);
  VDKTextView view1 = new VDKTextView(this);  
  view1->Buffer(textbuff);

void VDKTextView::Clear   [inline]
 

Clears text buffer deleting all text.

void VDKTextView::Eol   [inline]
 

Inserts a new line at insertion point

void VDKTextView::ForwardDelete int    nchars [inline]
 

Forward delete chars from insertion point

void VDKTextView::Freeze   [inline]
 

maintained for compatibility with old text widgets, but is dummy

gchar* VDKTextView::GetChars int    start = 0,
int    end = -1
[inline]
 

Returns a text segment

Parameters:
start  starting position
end  ending position, if -1 all text buffer from start to end will be returned.
Tip
Invisible chars won't be included. Returned address should be g_free()'d by user.

int VDKTextView::GetLineAtOffset int    offset [inline]
 

Gets line number at a buffer position

Parameters:
offset  buffer offset position (counting from 0) on error returns -1

bool VDKTextView::IsLineVisible int    line [inline]
 

Answer if a line is visible or not line are counted from 0

Parameters:
line 

bool VDKTextView::LoadFromFile char *    filename [inline]
 

Load text buffer with a file

Parameters:
filename 

bool VDKTextView::SaveToFile char *    filename [inline]
 

Save buffer to file

void VDKTextView::ScrollToLine int    line,
int    col,
int    margin = 0
 

Scrolls to a line,column leaving <margin> pixels free

void VDKTextView::ScrollToPos int    pointer = -1,
int    margin = 0
 

Scrolls to a pointer pos or (default) to current pointer position, leaving <margin> pixels free

void VDKTextView::SetBackground VDKRgb    color,
GtkStateType    state = GTK_STATE_NORMAL
[virtual]
 

Sets object background

Parameters:
color  a VDKRgb object
state  can be one of the gtk+ widget states

Reimplemented from VDKObject.

void VDKTextView::SetFont VDKFont   font [virtual]
 

Sets object font

Reimplemented from VDKObject.

void VDKTextView::SetForeground VDKRgb    rgb,
GtkStateType    state = GTK_STATE_NORMAL
[virtual]
 

Sets object foreground

Parameters:
color  a VDKRgb object
state  can be one of the gtk+ widget states

Reimplemented from VDKObject.

void VDKTextView::TextBorder int    size,
int    which = TVB_ALL
 

Sets borders around text window.

Parameters:
size  border size in pixels
which  side border should be set
  • TVB_LEFT
  • TVB_TOP
  • TVB_RIGHT
  • TVB_BOTTOM that can be ored togheter.
  • TVB_ALL (default) use this to set all sides border size.

void VDKTextView::TextInsert const char *    txt,
int    nchar = -1
[inline]
 

Inserts text at cursor position.

Parameters:
txt  null terminating string to be inserted
nchars  how many chars have to be inserted (-1 means all)

void VDKTextView::Thaw   [inline]
 

maintained for compatibility with old text widgets, but is dummy

void VDKTextView::Undo   [inline]
 

Undoes last operation


Member Data Documentation

VDKReadWriteValueProp<VDKTextView,bool> VDKTextView::Changed
 

Sets/gets modified flag

VDKReadWriteValueProp<VDKTextView,int> VDKTextView::Column
 

Sets/gets text insertion position expressed in column offset

VDKReadOnlyValueProp<VDKTextView,int> VDKTextView::FirstVisibleLine
 

Gets first visible line (lines are counted from 0)

VDKReadOnlyValueProp<VDKTextView,int> VDKTextView::LastVisibleLine
 

Gets last visible line (lines are counted from 0)

VDKReadWriteValueProp<VDKTextView,int> VDKTextView::Line
 

Sets/gets text insertion position expressed in lines

VDKReadWriteValueProp<VDKTextView,int> VDKTextView::Pointer
 

Sets/gets text insertion position expressed in chars from text beginning. (counting from 0, gets -1 on failure)


The documentation for this class was generated from the following files:
Generated on Wed Apr 17 13:25:00 2002 for vdk 2.0.1 by doxygen1.2.15