LibreOffice Module sw (master)  1
Classes | Typedefs | Enumerations | Functions | Variables
ww Namespace Reference

Classes

class  SortedArray
 simple template that manages a static array More...
 

Typedefs

typedef std::vector< sal_uInt8bytes
 

Enumerations

enum  sti {
  stiNormal = 0,
  stiLev1 = 1,
  stiLev2 = 2,
  stiLev3 = 3,
  stiLev4 = 4,
  stiLev5 = 5,
  stiLev6 = 6,
  stiLev7 = 7,
  stiLev8 = 8,
  stiLev9 = 9,
  stiLevFirst = stiLev1,
  stiLevLast = stiLev9,
  stiIndex1 = 10,
  stiIndex2 = 11,
  stiIndex3 = 12,
  stiIndex4 = 13,
  stiIndex5 = 14,
  stiIndex6 = 15,
  stiIndex7 = 16,
  stiIndex8 = 17,
  stiIndex9 = 18,
  stiIndexFirst = stiIndex1,
  stiIndexLast = stiIndex9,
  stiToc1 = 19,
  stiToc2 = 20,
  stiToc3 = 21,
  stiToc4 = 22,
  stiToc5 = 23,
  stiToc6 = 24,
  stiToc7 = 25,
  stiToc8 = 26,
  stiToc9 = 27,
  stiTocFirst = stiToc1,
  stiTocLast = stiToc9,
  stiNormIndent = 28,
  stiFootnoteText = 29,
  stiAtnText = 30,
  stiHeader = 31,
  stiFooter = 32,
  stiIndexHeading = 33,
  stiCaption = 34,
  stiToCaption = 35,
  stiEnvAddr = 36,
  stiEnvRet = 37,
  stiFootnoteRef = 38,
  stiAtnRef = 39,
  stiLnn = 40,
  stiPgn = 41,
  stiEdnRef = 42,
  stiEdnText = 43,
  stiToa = 44,
  stiMacro = 45,
  stiToaHeading = 46,
  stiList = 47,
  stiListBullet = 48,
  stiListNumber = 49,
  stiList2 = 50,
  stiList3 = 51,
  stiList4 = 52,
  stiList5 = 53,
  stiListBullet2 = 54,
  stiListBullet3 = 55,
  stiListBullet4 = 56,
  stiListBullet5 = 57,
  stiListNumber2 = 58,
  stiListNumber3 = 59,
  stiListNumber4 = 60,
  stiListNumber5 = 61,
  stiTitle = 62,
  stiClosing = 63,
  stiSignature = 64,
  stiNormalChar = 65,
  stiBodyText = 66,
  stiBodyTextInd1 = 67,
  stiListCont = 68,
  stiListCont2 = 69,
  stiListCont3 = 70,
  stiListCont4 = 71,
  stiListCont5 = 72,
  stiMsgHeader = 73,
  stiSubtitle = 74,
  stiSalutation = 75,
  stiDate = 76,
  stiBodyText1I = 77,
  stiBodyText1I2 = 78,
  stiNoteHeading = 79,
  stiBodyText2 = 80,
  stiBodyText3 = 81,
  stiBodyTextInd2 = 82,
  stiBodyTextInd3 = 83,
  stiBlockQuote = 84,
  stiHyperlink = 85,
  stiHyperlinkFollowed = 86,
  stiStrong = 87,
  stiEmphasis = 88,
  stiNavPane = 89,
  stiPlainText = 90,
  stiMax = 91,
  stiUser = 0x0ffe,
  stiNil = 0x0fff
}
 
enum  eField {
  eNONE = 0,
  eUNKNOWN = 1,
  ePOSSIBLEBOOKMARK = 2,
  eREF = 3,
  eXE = 4,
  eFOOTREF = 5,
  eSET = 6,
  eIF = 7,
  eINDEX = 8,
  eTC = 9,
  eSTYLEREF = 10,
  eRD = 11,
  eSEQ = 12,
  eTOC = 13,
  eINFO = 14,
  eTITLE = 15,
  eSUBJECT = 16,
  eAUTHOR = 17,
  eKEYWORDS = 18,
  eCOMMENTS = 19,
  eLASTSAVEDBY = 20,
  eCREATEDATE = 21,
  eSAVEDATE = 22,
  ePRINTDATE = 23,
  eREVNUM = 24,
  eEDITTIME = 25,
  eNUMPAGE = 26,
  eNUMWORDS = 27,
  eNUMCHARS = 28,
  eFILENAME = 29,
  eTEMPLATE = 30,
  eDATE = 31,
  eTIME = 32,
  ePAGE = 33,
  eEquals = 34,
  eQUOTE = 35,
  eMERGEINC = 36,
  ePAGEREF = 37,
  eASK = 38,
  eFILLIN = 39,
  eMERGEDATA = 40,
  eNEXT = 41,
  eNEXTIF = 42,
  eSKIPIF = 43,
  eMERGEREC = 44,
  eDDEREF = 45,
  eDDEAUTOREF = 46,
  eGLOSSREF = 47,
  ePRINT = 48,
  eEQ = 49,
  eGOTOBUTTON = 50,
  eMACROBUTTON = 51,
  eAUTONUMOUT = 52,
  eAUTONUMLGL = 53,
  eAUTONUM = 54,
  eINCLUDETIFF = 55,
  eLINK = 56,
  eSYMBOL = 57,
  eEMBED = 58,
  eMERGEFIELD = 59,
  eUSERNAME = 60,
  eUSERINITIALS = 61,
  eUSERADDRESS = 62,
  eBARCODE = 63,
  eDOCVARIABLE = 64,
  eSECTION = 65,
  eSECTIONPAGES = 66,
  eINCLUDEPICTURE = 67,
  eINCLUDETEXT = 68,
  eFILESIZE = 69,
  eFORMTEXT = 70,
  eFORMCHECKBOX = 71,
  eNOTEREF = 72,
  eTOA = 73,
  eTA = 74,
  eMERGESEQ = 75,
  eMACRO = 76,
  ePRIVATE = 77,
  eDATABASE = 78,
  eAUTOTEXT = 79,
  eCOMPARE = 80,
  ePLUGIN = 81,
  eSUBSCRIBER = 82,
  eFORMDROPDOWN = 83,
  eADVANCE = 84,
  eDOCPROPERTY = 85,
  eUNKNOWN2 = 86,
  eCONTROL = 87,
  eHYPERLINK = 88,
  eAUTOTEXTLIST = 89,
  eLISTNUM = 90,
  eHTMLCONTROL = 91,
  eBIDIOUTLINE = 92,
  eADDRESSBLOCK = 93,
  eGREETINGLINE = 94,
  eSHAPE = 95,
  eBIBLIOGRPAHY =96,
  eCITATION = 97,
  eFORMDATE = 98
}
 
enum  WordVersion {
  eWW1 = 1,
  eWW2 = 2,
  eWW6 = 6,
  eWW7 = 7,
  eWW8 = 8
}
 

Functions

sti GetCanonicalStiFromStc (sal_uInt8 stc) throw ()
 Find the WinWord sti index of an old <= Word2 stc (style code) More...
 
const sal_CharGetEnglishNameFromSti (sti eSti) throw ()
 Find the WinWord english name from a sti index. More...
 
bool StandardStiIsCharStyle (sti eSti) throw ()
 Determine if the WinWord sti is standard Character Style. More...
 
const char * GetEnglishFieldName (eField eIndex) throw ()
 Find the English Field Name from a winword index. More...
 
template<typename Ret , typename Param >
Ret checking_cast (Param in, Ret)
 
template<typename Ret >
Ret checking_cast (Ret in, Ret)
 
template<typename Ret , typename Param >
Ret needed_cast (Param in)
 
bool IsSevenMinus (WordVersion eVer)
 
bool IsEightPlus (WordVersion eVer)
 

Variables

const int nWrap100Percent = 21600
 For custom wrapping. More...
 

Detailed Description

Typedef Documentation

typedef std::vector<sal_uInt8> ww::bytes

Definition at line 29 of file types.hxx.

Enumeration Type Documentation

enum ww::eField
Enumerator
eNONE 
eUNKNOWN 
ePOSSIBLEBOOKMARK 
eREF 
eXE 
eFOOTREF 
eSET 
eIF 
eINDEX 
eTC 
eSTYLEREF 
eRD 
eSEQ 
eTOC 
eINFO 
eTITLE 
eSUBJECT 
eAUTHOR 
eKEYWORDS 
eCOMMENTS 
eLASTSAVEDBY 
eCREATEDATE 
eSAVEDATE 
ePRINTDATE 
eREVNUM 
eEDITTIME 
eNUMPAGE 
eNUMWORDS 
eNUMCHARS 
eFILENAME 
eTEMPLATE 
eDATE 
eTIME 
ePAGE 
eEquals 
eQUOTE 
eMERGEINC 
ePAGEREF 
eASK 
eFILLIN 
eMERGEDATA 
eNEXT 
eNEXTIF 
eSKIPIF 
eMERGEREC 
eDDEREF 
eDDEAUTOREF 
eGLOSSREF 
ePRINT 
eEQ 
eGOTOBUTTON 
eMACROBUTTON 
eAUTONUMOUT 
eAUTONUMLGL 
eAUTONUM 
eINCLUDETIFF 
eLINK 
eSYMBOL 
eEMBED 
eMERGEFIELD 
eUSERNAME 
eUSERINITIALS 
eUSERADDRESS 
eBARCODE 
eDOCVARIABLE 
eSECTION 
eSECTIONPAGES 
eINCLUDEPICTURE 
eINCLUDETEXT 
eFILESIZE 
eFORMTEXT 
eFORMCHECKBOX 
eNOTEREF 
eTOA 
eTA 
eMERGESEQ 
eMACRO 
ePRIVATE 
eDATABASE 
eAUTOTEXT 
eCOMPARE 
ePLUGIN 
eSUBSCRIBER 
eFORMDROPDOWN 
eADVANCE 
eDOCPROPERTY 
eUNKNOWN2 
eCONTROL 
eHYPERLINK 
eAUTOTEXTLIST 
eLISTNUM 
eHTMLCONTROL 
eBIDIOUTLINE 
eADDRESSBLOCK 
eGREETINGLINE 
eSHAPE 
eBIBLIOGRPAHY 
eCITATION 
eFORMDATE 

Definition at line 26 of file fields.hxx.

enum ww::sti
Enumerator
stiNormal 
stiLev1 
stiLev2 
stiLev3 
stiLev4 
stiLev5 
stiLev6 
stiLev7 
stiLev8 
stiLev9 
stiLevFirst 
stiLevLast 
stiIndex1 
stiIndex2 
stiIndex3 
stiIndex4 
stiIndex5 
stiIndex6 
stiIndex7 
stiIndex8 
stiIndex9 
stiIndexFirst 
stiIndexLast 
stiToc1 
stiToc2 
stiToc3 
stiToc4 
stiToc5 
stiToc6 
stiToc7 
stiToc8 
stiToc9 
stiTocFirst 
stiTocLast 
stiNormIndent 
stiFootnoteText 
stiAtnText 
stiHeader 
stiFooter 
stiIndexHeading 
stiCaption 
stiToCaption 
stiEnvAddr 
stiEnvRet 
stiFootnoteRef 
stiAtnRef 
stiLnn 
stiPgn 
stiEdnRef 
stiEdnText 
stiToa 
stiMacro 
stiToaHeading 
stiList 
stiListBullet 
stiListNumber 
stiList2 
stiList3 
stiList4 
stiList5 
stiListBullet2 
stiListBullet3 
stiListBullet4 
stiListBullet5 
stiListNumber2 
stiListNumber3 
stiListNumber4 
stiListNumber5 
stiTitle 
stiClosing 
stiSignature 
stiNormalChar 
stiBodyText 
stiBodyTextInd1 
stiListCont 
stiListCont2 
stiListCont3 
stiListCont4 
stiListCont5 
stiMsgHeader 
stiSubtitle 
stiSalutation 
stiDate 
stiBodyText1I 
stiBodyText1I2 
stiNoteHeading 
stiBodyText2 
stiBodyText3 
stiBodyTextInd2 
stiBodyTextInd3 
stiBlockQuote 
stiHyperlink 
stiHyperlinkFollowed 
stiStrong 
stiEmphasis 
stiNavPane 
stiPlainText 
stiMax 
stiUser 
stiNil 

Definition at line 27 of file wwstyles.hxx.

Enumerator
eWW1 
eWW2 
eWW6 
eWW7 
eWW8 

Definition at line 31 of file types.hxx.

Function Documentation

template<typename Ret , typename Param >
Ret ww::checking_cast ( Param  in,
Ret   
)

Definition at line 27 of file needed_cast.hxx.

Referenced by needed_cast().

template<typename Ret >
Ret ww::checking_cast ( Ret  in,
Ret   
)

Definition at line 32 of file needed_cast.hxx.

sti ww::GetCanonicalStiFromStc ( sal_uInt8  stc)
throw (
)

Find the WinWord sti index of an old <= Word2 stc (style code)

When importing a Word 2 document we would like to treat styles as similar to how word 8 does as possible, to this end word will treat some styles with special codes as inbuilt styles, and some as user defined styles.

Parameters
stcthe Style code to test to see what winword sti word would give such a code
Returns
the sti that word would give it. stiUser if word would treat it as a user defined style.

Definition at line 158 of file styles.cxx.

References stiAtnRef, stiAtnText, stiFooter, stiFootnoteRef, stiFootnoteText, stiHeader, stiIndex1, stiIndex2, stiIndex3, stiIndex4, stiIndex5, stiIndex6, stiIndex7, stiIndexHeading, stiLev1, stiLev2, stiLev3, stiLev4, stiLev5, stiLev6, stiLev7, stiLev8, stiLev9, stiLnn, stiNil, stiNormal, stiNormIndent, stiToc1, stiToc2, stiToc3, stiToc4, stiToc5, stiToc6, stiToc7, stiToc8, and stiUser.

Referenced by WW8RStyle::ImportOldFormatStyles().

const char * ww::GetEnglishFieldName ( eField  eIndex)
throw (
)

Find the English Field Name from a winword index.

See OpenOffice.org issue 12831 (https://bz.apache.org/ooo/show_bug.cgi?id=12831) and MS Knowledge Base article 268717 (http://support.microsoft.com/default.aspx?scid=kb;en-us;268717) for details of why to use english field names and not localized ones since Word 2000.

Parameters
nIndexthe index to search for
Returns
0 if not found, otherwise the fieldname as a C style ASCII string

Definition at line 26 of file fields.cxx.

References aFieldNames, eNONE, and SAL_N_ELEMENTS.

Referenced by FieldString().

const sal_Char * ww::GetEnglishNameFromSti ( sti  eSti)
throw (
)

Find the WinWord english name from a sti index.

Map the word style index to its english name

Parameters
stithe Style index
Returns
the name word would give it if it's an inbuilt name, otherwise NULL

Definition at line 134 of file styles.cxx.

References stiMax.

Referenced by WW8RStyle::ImportOldFormatStyles(), and DocxAttributeOutput::StartStyle().

bool ww::IsEightPlus ( WordVersion  eVer)
inline
bool ww::IsSevenMinus ( WordVersion  eVer)
inline
template<typename Ret , typename Param >
Ret ww::needed_cast ( Param  in)

Definition at line 43 of file needed_cast.hxx.

References checking_cast().

Referenced by sw::types::msword_cast(), and sw::types::writer_cast().

bool ww::StandardStiIsCharStyle ( sti  eSti)
throw (
)

Determine if the WinWord sti is standard Character Style.

Parameters
stithe Style index
Returns
true if a known inbuild character style

Definition at line 142 of file styles.cxx.

References stiAtnRef, stiEdnRef, stiFootnoteRef, stiLnn, stiNormalChar, and stiPgn.

Referenced by WW8RStyle::ImportOldFormatStyles().

Variable Documentation

const int ww::nWrap100Percent = 21600

For custom wrapping.

When you edit the wrap points of a contour in word, word uses a relative scale of 0 to 21600 where 21600 is apparently 100% of the graphic width

Definition at line 40 of file types.hxx.

Referenced by sw::util::CorrectWordWrapPolygonForExport(), and SwWW8ImplReader::MapWrapIntoFlyFormat().