Enumerations
enum	statusIndicatorCallbackType { statusIndicatorCallbackType::Start, statusIndicatorCallbackType::SetValue, statusIndicatorCallbackType::Finish }

enum	Compat : sal_uInt32 { none = 0, scNoGridBackground = 1 }

Functions
static bool	g_bActive (false)

static bool	g_bPartInInvalidation (false)

static bool	g_bTiledPainting (false)

static bool	g_bDialogPainting (false)

static bool	g_bTiledAnnotations (true)

static bool	g_bRangeHeaders (false)

static bool	g_bViewIdForVisCursorInvalidation (false)

static bool	g_bLocalRendering (false)

static Compat	g_eCompatFlags (Compat::none)

static double	g_fDPIScale (1.0)
	Scaling of the cairo canvas painting for hi-dpi. More...

void	setActive (bool bActive)

bool	isActive ()

void	setMobile (int nViewId, bool bMobile)

bool	isMobile (int nViewId)

void	setPartInInvalidation (bool bPartInInvalidation)
	Set whether clients want a part number in an invalidation payload. More...

bool	isPartInInvalidation ()
	Check whether clients want a part number in an invalidation payload. More...

void	setTiledPainting (bool bTiledPainting)
	Set if we are doing tiled painting. More...

bool	isTiledPainting ()
	Check if we are doing tiled painting. More...

void	setDialogPainting (bool bDialogPainting)
	Set if we are painting the dialog. More...

bool	isDialogPainting ()
	Check if we are painting the dialog. More...

void	setDPIScale (double fDPIScale)
	Set the DPI scale for rendering for HiDPI displays. More...

double	getDPIScale ()
	Get the DPI scale for rendering for HiDPI displays. More...

void	setTiledAnnotations (bool bTiledAnnotations)
	Set if we want no annotations rendering. More...

bool	isTiledAnnotations ()
	Check if annotations rendering is turned off. More...

void	setRangeHeaders (bool bTiledAnnotations)
	Set if we want range based header data. More...

void	setViewIdForVisCursorInvalidation (bool bViewIdForVisCursorInvalidation)
	Set whether clients want viewId in visible cursor invalidation payload. More...

bool	isViewIdForVisCursorInvalidation ()
	Check whether clients want viewId in visible cursor invalidation payload. More...

bool	isRangeHeaders ()
	Check if range based header data is enabled. More...

void	setLocalRendering (bool bLocalRendering=true)
	Shift the coordinates before rendering each bitmap. More...

bool	isLocalRendering ()

void	setCompatFlag (Compat flag)
	Set compatibility flags. More...

bool	isCompatFlagSet (Compat flag)
	Get compatibility flags. More...

void	setLanguageTag (const OUString &lang, bool bCanonicalize=false)
	Update the current LOK's language. More...

void	setLanguageTag (const LanguageTag &languageTag)
	Update the current LOK's language. More...

const LanguageTag &	getLanguageTag ()
	Get the current LOK's language. More...

bool	isWhitelistedLanguage (const OUString &lang)
	If the language name should be used for this LOK instance. More...

static void *	pStatusIndicatorCallbackData (nullptr)

void	setStatusIndicatorCallback (void(callback)(void data, statusIndicatorCallbackType type, int percent), void *data)

void	statusIndicatorStart ()

void	statusIndicatorSetValue (int percent)

void	statusIndicatorFinish ()

Variables
static LanguageTag	g_aLanguageTag ("en-US", true)

static std::map< int, bool >	g_vIsViewMobile
	List of <viewid, bMobile> pairs. More...

static void(*	pStatusIndicatorCallback )(void *data, statusIndicatorCallbackType type, int percent)(nullptr)

Enumeration Type Documentation

enum comphelper::LibreOfficeKit::Compat : sal_uInt32

Enumerator
none
scNoGridBackground

Definition at line 81 of file lok.hxx.

enum comphelper::LibreOfficeKit::statusIndicatorCallbackType

strong

Enumerator
Start
SetValue
Finish

Definition at line 35 of file lok.hxx.

Function Documentation

static bool comphelper::LibreOfficeKit::g_bActive ( false )

static

Referenced by isActive().

static bool comphelper::LibreOfficeKit::g_bDialogPainting ( false )

static

Referenced by isDialogPainting().

static bool comphelper::LibreOfficeKit::g_bLocalRendering ( false )

static

Referenced by isLocalRendering().

static bool comphelper::LibreOfficeKit::g_bPartInInvalidation ( false )

static

Referenced by isPartInInvalidation().

static bool comphelper::LibreOfficeKit::g_bRangeHeaders ( false )

static

Referenced by isRangeHeaders().

static bool comphelper::LibreOfficeKit::g_bTiledAnnotations ( true )

static

Referenced by isTiledAnnotations().

static bool comphelper::LibreOfficeKit::g_bTiledPainting ( false )

static

Referenced by isTiledPainting().

static bool comphelper::LibreOfficeKit::g_bViewIdForVisCursorInvalidation ( false )

static

Referenced by isViewIdForVisCursorInvalidation().

static Compat comphelper::LibreOfficeKit::g_eCompatFlags ( Compat::none )

static

static double comphelper::LibreOfficeKit::g_fDPIScale ( 1. 0 )

static

Scaling of the cairo canvas painting for hi-dpi.

Referenced by getDPIScale().

COMPHELPER_DLLPUBLIC double comphelper::LibreOfficeKit::getDPIScale ( )

Get the DPI scale for rendering for HiDPI displays.

Definition at line 107 of file lok.cxx.

References g_fDPIScale().

COMPHELPER_DLLPUBLIC const LanguageTag & comphelper::LibreOfficeKit::getLanguageTag ( )

Get the current LOK's language.

Definition at line 170 of file lok.cxx.

References g_aLanguageTag.

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isActive ( )

Definition at line 51 of file lok.cxx.

References g_bActive().

Referenced by isWhitelistedLanguage().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isCompatFlagSet ( Compat flag )

Get compatibility flags.

Definition at line 154 of file lok.cxx.

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isDialogPainting ( )

Check if we are painting the dialog.

Definition at line 97 of file lok.cxx.

References g_bDialogPainting().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isLocalRendering ( )

Definition at line 147 of file lok.cxx.

References g_bLocalRendering().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isMobile ( int nViewId )

Definition at line 64 of file lok.cxx.

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isPartInInvalidation ( )

Check whether clients want a part number in an invalidation payload.

Definition at line 77 of file lok.cxx.

References g_bPartInInvalidation().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isRangeHeaders ( )

Check if range based header data is enabled.

Definition at line 137 of file lok.cxx.

References g_bRangeHeaders().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isTiledAnnotations ( )

Check if annotations rendering is turned off.

Definition at line 117 of file lok.cxx.

References g_bTiledAnnotations().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isTiledPainting ( )

Check if we are doing tiled painting.

Definition at line 87 of file lok.cxx.

References g_bTiledPainting().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isViewIdForVisCursorInvalidation ( )

Check whether clients want viewId in visible cursor invalidation payload.

Definition at line 132 of file lok.cxx.

References g_bViewIdForVisCursorInvalidation().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isWhitelistedLanguage ( const OUString & lang )

If the language name should be used for this LOK instance.

Definition at line 175 of file lok.cxx.

References isActive(), stream, and void().

static void* comphelper::LibreOfficeKit::pStatusIndicatorCallbackData ( nullptr )

static

Referenced by setStatusIndicatorCallback(), statusIndicatorFinish(), statusIndicatorSetValue(), and statusIndicatorStart().

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setActive ( bool bActive )

Definition at line 46 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setCompatFlag ( Compat flag )

Set compatibility flags.

Definition at line 152 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setDialogPainting ( bool bDialogPainting )

Set if we are painting the dialog.

Definition at line 92 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setDPIScale ( double fDPIScale )

Set the DPI scale for rendering for HiDPI displays.

Definition at line 102 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setLanguageTag	(	const OUString &	lang,
		bool	bCanonicalize
	)

Update the current LOK's language.

Definition at line 156 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setLanguageTag ( const LanguageTag & languageTag )

Update the current LOK's language.

Definition at line 161 of file lok.cxx.

References LanguageTag::getBcp47(), and SAL_INFO.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setLocalRendering ( bool bLocalRendering = true )

Shift the coordinates before rendering each bitmap.

Used by Calc to render each tile separately. This should be unnecessary (and removed) once Calc moves to using 100MM Unit.

Definition at line 142 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setMobile	(	int	nViewId,
		bool	bMobile
	)

Definition at line 56 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setPartInInvalidation ( bool bPartInInvalidation )

Set whether clients want a part number in an invalidation payload.

Definition at line 72 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setRangeHeaders ( bool bRangeHeaders )

Set if we want range based header data.

Definition at line 122 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setStatusIndicatorCallback	(	void()(void data, statusIndicatorCallbackType type, int percent)	callback,
		void *	data
	)