rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Application Framework Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvDvTextDocument Class Reference

Application Framework document text class. More...

#include <ilviews/appframe/doctext.h>

Inheritance diagram for IlvDvTextDocument:
IlvDvDocument IlvDvSerializable IlvDvInterface

List of all members.

Public Member Functions

const char * getText () const
 Returns the document text.
virtual void serialize (IlvDvStream &stream)
 Loads and saves the document text to and from the stream parameter.
void setEditable (IlBoolean editable)
 Sets whether the text can be edited by all associated document views.
void setText (const IlvString &text, IlvDvDocViewInterface *view=0)
 Sets the text text to the document.

Detailed Description

Application Framework document text class.

Library: ilvappframe

IlvDvTextDocument is a subclass of IlvDvDocument. It loads and saves text and it provides basic accessors that let the associated document views access the text.


Member Function Documentation

const char* IlvDvTextDocument::getText (  )  const

Returns the document text.

Returns:
The document text.
virtual void IlvDvTextDocument::serialize ( IlvDvStream stream  )  [virtual]

Loads and saves the document text to and from the stream parameter.

Parameters:
stream Specifies the stream used to perform serialization.

Reimplemented from IlvDvDocument.

void IlvDvTextDocument::setEditable ( IlBoolean  editable  ) 

Sets whether the text can be edited by all associated document views.

Parameters:
editable Specifies if the text can be edited by the associated document views.
void IlvDvTextDocument::setText ( const IlvString &  text,
IlvDvDocViewInterface view = 0 
)

Sets the text text to the document.

Parameters:
view If the new text is set by a document view, this view is passed as the view parameter.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.