pp_Property.h File Reference

#include <memory>
#include <string>
#include <vector>
#include "ut_types.h"
#include "ut_misc.h"
#include "ut_units.h"
#include "pp_PropertyMap.h"

Go to the source code of this file.

Classes
class	PP_PropertyType
class	PP_PropertyTypeBool
class	PP_PropertyTypeInt
class	PP_PropertyTypeSize
class	PP_PropertyTypeColor
class	PP_Property
Defines
#define	pp_BASEDON_DEPTH_LIMIT   10
#define	ASSERT_PV_SIZE(x)   UT_ASSERT(x.size() % 2 == 0)
#define	PP_LEVEL_CHAR   0x00000001
#define	PP_LEVEL_BLOCK   0x00000002
#define	PP_LEVEL_SECT   0x00000004
#define	PP_LEVEL_DOC   0x00000008
#define	PP_LEVEL_TABLE   0x00000010
#define	PP_LEVEL_OBJ   0x00000020
#define	PP_LEVEL_IMG   0x00000040
#define	PP_LEVEL_FIELD   0x00000080
#define	PP_LEVEL_FRAME   0x00000100
Typedefs
typedef std::vector< std::string >	PP_PropertyVector
	A basic container of properties vector.
typedef unsigned int	tPropLevel
Enumerations
enum	tProperty_type { Property_type_bool, Property_type_int, Property_type_size, Property_type_color }
Functions
ABI_EXPORT const PP_Property *	PP_lookupProperty (const gchar *pszName)
ABI_EXPORT void	PP_resetInitialBiDiValues (const gchar *pszValue)
ABI_EXPORT void	PP_setDefaultFontFamily (const char *pszFamily)
ABI_EXPORT const gchar *	PP_evalProperty (const gchar *pszName, const PP_AttrProp *pSpanAttrProp, const PP_AttrProp *pBlockAttrProp, const PP_AttrProp *pSectionAttrProp, const PD_Document *pDoc, bool bExpandStyles=false)
ABI_EXPORT std::unique_ptr < PP_PropertyType >	PP_evalPropertyType (const gchar *pszName, const PP_AttrProp *pSpanAttrProp, const PP_AttrProp *pBlockAttrProp, const PP_AttrProp *pSectionAttrProp, tProperty_type Type, const PD_Document *pDoc=NULL, bool bExpandStyles=false)
ABI_EXPORT UT_uint32	PP_getPropertyCount ()
ABI_EXPORT const gchar *	PP_getNthPropertyName (UT_uint32 n)
ABI_EXPORT tPropLevel	PP_getNthPropertyLevel (UT_uint32 n)

---

Define Documentation

#define ASSERT_PV_SIZE

(

x

)

UT_ASSERT(x.size() % 2 == 0)

Referenced by OXML_ObjectWithAttrProp::_generatePropsString(), pt_PieceTable::_realChangeStruxFmt(), OXML_ObjectWithAttrProp::appendAttributes(), OXML_ObjectWithAttrProp::appendProperties(), PP_AttrProp::areAlreadyPresent(), PP_AttrProp::areAnyOfTheseNamesPresent(), IE_Exp_DocRangeListener::assembleAtts(), PD_Document::changeDocPropeties(), PP_AttrProp::cloneWithElimination(), PP_AttrProp::cloneWithEliminationIfEqual(), FV_View::cmdInsertLatexMath(), FV_View::cmdUpdateEmbed(), AP_Dialog_Lists::findVecItem(), OXML_ObjectWithAttrProp::getAttributesWithProps(), and fp_PageSize::Set().

#define pp_BASEDON_DEPTH_LIMIT   10

Referenced by PD_Style::_getAttributeExpand(), PD_Style::_getPropertyExpand(), PD_Style::getAllAttributes(), PD_Style::getAllProperties(), PD_Document::getAllUsedStyles(), PP_evalPropertyType(), and s_evalProperty().

#define PP_LEVEL_BLOCK   0x00000002

Referenced by FV_View::getBlockFormat().

#define PP_LEVEL_CHAR   0x00000001

Referenced by FV_View::getCharFormat().

#define PP_LEVEL_DOC   0x00000008

#define PP_LEVEL_FIELD   0x00000080

#define PP_LEVEL_FRAME   0x00000100

#define PP_LEVEL_IMG   0x00000040

#define PP_LEVEL_OBJ   0x00000020

#define PP_LEVEL_SECT   0x00000004

Referenced by FV_View::getSectionFormat().

#define PP_LEVEL_TABLE   0x00000010

Referenced by FV_View::getCellFormat().

---

Typedef Documentation

typedef std::vector<std::string> PP_PropertyVector

A basic container of properties vector.

This replaces the gchar**

typedef unsigned int tPropLevel

---

Enumeration Type Documentation

enum tProperty_type

Enumerator:

Property_type_bool
Property_type_int
Property_type_size
Property_type_color

---

Function Documentation

ABI_EXPORT const gchar* PP_evalProperty	(	const gchar *	pszName,
		const PP_AttrProp *	pSpanAttrProp,
		const PP_AttrProp *	pBlockAttrProp,
		const PP_AttrProp *	pSectionAttrProp,
		const PD_Document *	pDoc,
		bool	bExpandStyles = false
	)

References PP_Property::canInherit(), gchar, PD_Document::getAttrProp(), PP_Property::getInitial(), PD_Style::getProperty(), PP_AttrProp::getProperty(), PD_Document::getStyle(), PP_lookupProperty(), s_evalProperty(), and UT_DEBUGMSG.

Referenced by s_RTF_ListenerGetProps::_compute_span_properties(), fp_TabRun::_draw(), _fmtPair::_fmtPair(), s_RTF_ListenerWriteDoc::_getColumnWidthInches(), s_XSL_FO_Listener::_handlePageSize(), fp_TextRun::_lookupProperties(), fp_FieldRun::_lookupProperties(), fp_TabRun::_lookupProperties(), fp_MathRun::_lookupProperties(), fp_FmtMarkRun::_lookupProperties(), fp_EmbedRun::_lookupProperties(), fl_DocSectionLayout::_lookupProperties(), fl_BlockLayout::_lookupProperties(), IE_Exp_HTML_Listener::_makeStylesheet(), s_RTF_ListenerWriteDoc::_rtf_docfmt(), s_RTF_ListenerWriteDoc::_rtf_open_section(), s_RTF_ListenerGetProps::_searchCellAPI(), s_RTF_ListenerGetProps::_searchTableAPI(), IE_Exp_RTF::_write_parafmt(), s_KWord_1_Listener::_writeMarginSize(), fp_Run::drawDecors(), FL_DocLayout::findFont(), FV_View::getBlockFormat(), FV_View::getCharFormat(), s_RTF_AttrPropAdapter_AP::getProperty(), fl_BlockLayout::getProperty(), FV_View::getSectionFormat(), fl_BlockLayout::itemizeSpan(), fp_Run::lookupProperties(), Text_Listener::populateStrux(), s_RTF_ListenerGetProps::populateStrux(), and FV_View::queryCharFormat().

ABI_EXPORT std::unique_ptr<PP_PropertyType> PP_evalPropertyType	(	const gchar *	pszName,
		const PP_AttrProp *	pSpanAttrProp,
		const PP_AttrProp *	pBlockAttrProp,
		const PP_AttrProp *	pSectionAttrProp,
		tProperty_type	Type,
		const PD_Document *	pDoc = NULL,
		bool	bExpandStyles = false
	)

References _getStyle(), PP_Property::canInherit(), PD_Style::getBasedOn(), PP_Property::getInitialType(), PP_Property::getName(), PD_Style::getPropertyType(), PP_AttrProp::getPropertyType(), PD_Document::getStyle(), pp_BASEDON_DEPTH_LIMIT, PP_lookupProperty(), and UT_DEBUGMSG.

Referenced by fp_TextRun::_lookupProperties(), fp_MathRun::_lookupProperties(), and fl_BlockLayout::getPropertyType().

ABI_EXPORT tPropLevel PP_getNthPropertyLevel

(

UT_uint32

n

)

References PP_Property::getLevel().

Referenced by FV_View::getBlockFormat(), FV_View::getCellFormat(), FV_View::getCharFormat(), and FV_View::getSectionFormat().

ABI_EXPORT const gchar* PP_getNthPropertyName

(

UT_uint32

n

)

References PP_Property::getName().

Referenced by FV_View::getBlockFormat(), FV_View::getCellFormat(), FV_View::getCharFormat(), and FV_View::getSectionFormat().

ABI_EXPORT UT_uint32 PP_getPropertyCount

(

)

Referenced by FV_View::getBlockFormat(), FV_View::getCellFormat(), FV_View::getCharFormat(), and FV_View::getSectionFormat().

ABI_EXPORT const PP_Property* PP_lookupProperty

(

const gchar *

pszName

)

References s_compare().

Referenced by ODe_Text_Listener::_initDefaultHeadingStyles(), IE_Exp_HTML_Listener::_insertTOC(), fl_TOCLayout::getDefaultDestStyle(), fl_TOCLayout::getDefaultSourceStyle(), ODe_Text_Listener::openTOC(), ODe_HeadingSearcher_Listener::openTOC(), PP_evalProperty(), PP_evalPropertyType(), AP_Dialog_Paragraph::setDialogData(), and AP_Dialog_FormatTOC::setPropFromDoc().

ABI_EXPORT void PP_resetInitialBiDiValues

(

const gchar *

pszValue

)

References gchar, PP_Property::m_pszInitial, and UT_DEBUGMSG.

Referenced by FV_View::FV_View().

ABI_EXPORT void PP_setDefaultFontFamily

(

const char *

pszFamily

)

References UT_String::c_str(), gchar, PP_Property::m_pszInitial, and s_compare().

Referenced by FV_View::FV_View().