NiXPSObjects::NOTextSelection Class Reference

#include "NOTextSelection.h"

List of all members.

Public Member Functions

UInt32 getNumberOfSelections ()
void getSelection (UInt32 pIndex, UInt32 &pId, doubleMatrix &pMatrix, doubleRect &pRect)
NiXPSObjects::NOString getSelectedTextPart (UInt32 pIndex)


Detailed Description

Class to manage selected text objects on a page. Text selections are what is shown with a yellow mark box in NiXPS Edit. This is not the same as object selections with NOSelection. Text selections are specifically for text objects and can be about a part of the text. This part is indicated with a transformed rectangle. You can manipulate the text selection of a page using calls on NOPage, like findAndSelectText and getTextSelection.

Member Function Documentation

UInt32 NiXPSObjects::NOTextSelection::getNumberOfSelections (  ) 

The number of text selections currently active.

Set the selection to a given id with a matrix and a rectangle

Parameters:
pId The id of the text object to set selected
pMatrix The matrix that is relevant to the text selection. You get this matrix from getSelection
pRect The rectangle that is relevant to the text selection. You get this rectangle from getSelection void setSelection(UInt32 pId, doubleMatrix pMatrix, doubleRect pRect);

void NiXPSObjects::NOTextSelection::getSelection ( UInt32  pIndex,
UInt32 &  pId,
doubleMatrix &  pMatrix,
doubleRect &  pRect 
)

Get selection with index pIndex

Parameters:
pIndex The index of the selection to get
pId on return will contain the ID of the selected object
pMatrix The matrix of the relevant part of the selection
pRect The rectangle of the relevant part of the selection

NiXPSObjects::NOString NiXPSObjects::NOTextSelection::getSelectedTextPart ( UInt32  pIndex  ) 

Returns the part of the text that is selected as a UTF-8 encoded string

Parameters:
pIndex The index of the selection to get


The documentation for this class was generated from the following files:
Generated on Thu Jul 3 15:30:45 2008 for NiXPS Library SDK by  doxygen 1.5.3