Main Page   Compound List   File List   Compound Members   Examples  

IGraphmatFile Interface Reference

import "graphan.idl";

List of all members.

Public Methods

HRESULT bMacSynHierarchy ([out, retval] BOOL *pVal)
HRESULT XmlMacSynOutputFile ([out, retval] BSTR *pVal)
HRESULT Language ([out, retval] int *pVal)
HRESULT bEmptyLineIsSentenceDelim ([out, retval] BOOL *pVal)
HRESULT bUseParagraphTagToDivide ([out, retval] BOOL *pVal)
HRESULT bUseIndention ([out, retval] BOOL *pVal)
HRESULT bSubdueWrongMacroSynUnitToMainRoot ([out, retval] BOOL *pVal)
HRESULT GraOutputFile ([out, retval] BSTR *pVal)
HRESULT LoadDicts ()
HRESULT LoadFileToGraphan ([in] BSTR CommandLine)
HRESULT LoadStringToGraphan ([in] BSTR Buffer)
HRESULT IsTableLoaded ([out, retval] BOOL *pVal)
HRESULT GetLineCount ([retval, out]UINT *Count)
HRESULT GetWord ([in] UINT LineNo,[retval, out] BSTR *s)
HRESULT HasDescr ([in] UINT LineNo,[in]UINT D,[retval, out] BOOL *result)
HRESULT GetDescriptorStr ([in] UINT DescriptorNo,[retval, out] BSTR *result)
HRESULT GetLine ([in] UINT LineNo,[retval, out] BSTR *result)
HRESULT GetOborotNo ([in] UINT LineNo,[retval, out] LONG *result)
HRESULT SetOborDic ([in] IUnknown *Dic)
HRESULT GetUnitOffset ([in] int LineNo,[out, retval] int *Offset)
HRESULT GetUnitLength ([in] int LineNo,[out, retval] BYTE *Length)
HRESULT FreeTable ()
HRESULT FreeDicts ()
HRESULT GetTokenLanguage ([in] int LineNo,[out, retval]int *Language)


Detailed Description

The main interface of Module Graphematics.


Member Function Documentation

HRESULT IGraphmatFile::bEmptyLineIsSentenceDelim (  [out, retval] BOOL *    pVal ) 
 

true, if empty lines are sentence delimiters

HRESULT IGraphmatFile::bMacSynHierarchy (  [out, retval] BOOL *    pVal ) 
 

true, if the module builds macro-syntax hierarchy

HRESULT IGraphmatFile::bSubdueWrongMacroSynUnitToMainRoot (  [out, retval] BOOL *    pVal ) 
 

true, if the module subdues unknown macro-syntax units to the meta root

HRESULT IGraphmatFile::bUseIndention (  [out, retval] BOOL *    pVal ) 
 

true, if the module uses indention to find paragraphs

HRESULT IGraphmatFile::bUseParagraphTagToDivide (  [out, retval] BOOL *    pVal ) 
 

true, if the module considers "</p>" as a paragraph

HRESULT IGraphmatFile::FreeDicts (    ) 
 

free all dictionaries

HRESULT IGraphmatFile::FreeTable (    ) 
 

delete the current graphematical table

HRESULT IGraphmatFile::GetDescriptorStr (  [in] UINT    DescriptorNo,
[retval, out] BSTR *    result
) 
 

get a string representation of a graphematical descriptor

HRESULT IGraphmatFile::GetLine (  [in] UINT    LineNo,
[retval, out] BSTR *    result
) 
 

get a string representation of row LineNo from the graphematical table

HRESULT IGraphmatFile::GetLineCount (  [retval, out] UINT *    Count ) 
 

get the number of lines in the graphematical table

HRESULT IGraphmatFile::GetOborotNo (  [in] UINT    LineNo,
[retval, out] LONG *    result
) 
 

get a oborot index that starts from LineNo, -1 if there is no oborots

HRESULT IGraphmatFile::GetTokenLanguage (  [in] int    LineNo,
[out, retval] int *    Language
) 
 

get the language of token at line LineNo

HRESULT IGraphmatFile::GetUnitLength (  [in] int    LineNo,
[out, retval] BYTE *    Length
) 
 

get the length of the input token of line LineNo

HRESULT IGraphmatFile::GetUnitOffset (  [in] int    LineNo,
[out, retval] int *    Offset
) 
 

get offset in the input buffer of line LineNo, for plain text files or strings this offset is equal to the file offset

HRESULT IGraphmatFile::GetWord (  [in] UINT    LineNo,
[retval, out] BSTR *    s
) 
 

get the word by the line index

HRESULT IGraphmatFile::GraOutputFile (  [out, retval] BSTR *    pVal ) 
 

file for graphematical table, by default it is empty

HRESULT IGraphmatFile::HasDescr (  [in] UINT    LineNo,
[in] UINT    D,
[retval, out] BOOL *    result
) 
 

true, if a line index <a> LineNo in the graphematical table contains descriptor <a>D

HRESULT IGraphmatFile::IsTableLoaded (  [out, retval] BOOL *    pVal ) 
 

true, if a file or s string was loaded into the module

HRESULT IGraphmatFile::Language (  [out, retval] int *    pVal ) 
 

the language of the input text: Russian = 1, English = 2, German = 3

HRESULT IGraphmatFile::LoadDicts (    ) 
 

initializes the whole module, loads dictionaries

HRESULT IGraphmatFile::LoadFileToGraphan (  [in] BSTR    CommandLine ) 
 

load a file into graphematics

HRESULT IGraphmatFile::LoadStringToGraphan (  [in] BSTR    Buffer ) 
 

load a string into graphematics

HRESULT IGraphmatFile::SetOborDic (  [in] IUnknown *    Dic ) 
 

set a pointer to oborot-dictionary. It should be set before calling LoadDicts, otherwise another copy of the dictionary would be loaded by the module itself

HRESULT IGraphmatFile::XmlMacSynOutputFile (  [out, retval] BSTR *    pVal ) 
 

an .xml file to write macro syntax hierarchy of the input text


The documentation for this interface was generated from the following file:
Generated on Sat Jun 25 17:04:48 2005 for Graphan by doxygen1.2.18