LibreOffice Module comphelper (master)  1
Enumerations | Functions | Variables
comphelper::LibreOfficeKit Namespace Reference

Enumerations

enum  statusIndicatorCallbackType {
  statusIndicatorCallbackType::Start,
  statusIndicatorCallbackType::SetValue,
  statusIndicatorCallbackType::Finish
}
 
enum  Compat : sal_uInt32 {
  none = 0,
  scNoGridBackground = 1,
  scPrintTwipsMsgs = 2
}
 

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 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 setLocale (const LanguageTag &languageTag)
 Update the current LOK's locale. More...
 
const LanguageTaggetLocale ()
 Get the current LOK's locale. More...
 
void setLanguageTag (const LanguageTag &languageTag)
 Update the current LOK's language. More...
 
const LanguageTaggetLanguageTag ()
 Get the current LOK's language. More...
 
bool isAllowlistedLanguage (const OUString &lang)
 If the language name should be used for this LOK instance. More...
 
static voidpStatusIndicatorCallbackData (nullptr)
 
void setStatusIndicatorCallback (void(*callback)(void *data, statusIndicatorCallbackType type, int percent, const char *pText), void *data)
 
void statusIndicatorStart (const OUString &sText)
 
void statusIndicatorSetValue (int percent)
 
void statusIndicatorFinish ()
 
COMPHELPER_DLLPUBLIC void setBlockedCommandList (const char *blockedCommandList)
 

Variables

static LanguageAndLocale g_aLanguageAndLocale
 
static void(* pStatusIndicatorCallback )(void *data, statusIndicatorCallbackType type, int percent, const char *pText)(nullptr)
 

Enumeration Type Documentation

Enumerator
none 
scNoGridBackground 
scPrintTwipsMsgs 

Definition at line 77 of file lok.hxx.

Enumerator
Start 
SetValue 
Finish 

Definition at line 28 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
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(), and setDPIScale().

COMPHELPER_DLLPUBLIC double comphelper::LibreOfficeKit::getDPIScale ( )

Get the DPI scale for rendering for HiDPI displays.

Definition at line 136 of file lok.cxx.

References g_fDPIScale().

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

Get the current LOK's language.

Definition at line 202 of file lok.cxx.

References LanguageTag::getLanguageType(), LANGUAGE_NONE, and SAL_INFO_IF.

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

Get the current LOK's locale.

Definition at line 190 of file lok.cxx.

References LanguageTag::getLanguageType(), LANGUAGE_NONE, and SAL_INFO_IF.

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isActive ( )

Definition at line 96 of file lok.cxx.

References g_bActive().

Referenced by isAllowlistedLanguage().

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

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

Definition at line 209 of file lok.cxx.

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

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

Get compatibility flags.

Definition at line 183 of file lok.cxx.

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isDialogPainting ( )

Check if we are painting the dialog.

Definition at line 126 of file lok.cxx.

References g_bDialogPainting().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isLocalRendering ( )

Definition at line 176 of file lok.cxx.

References g_bLocalRendering().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isPartInInvalidation ( )

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

Definition at line 106 of file lok.cxx.

References g_bPartInInvalidation().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isRangeHeaders ( )

Check if range based header data is enabled.

Definition at line 166 of file lok.cxx.

References g_bRangeHeaders().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isTiledAnnotations ( )

Check if annotations rendering is turned off.

Definition at line 146 of file lok.cxx.

References g_bTiledAnnotations().

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isTiledPainting ( )

Check if we are doing tiled painting.

Definition at line 116 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 161 of file lok.cxx.

References g_bViewIdForVisCursorInvalidation().

static void* comphelper::LibreOfficeKit::pStatusIndicatorCallbackData ( nullptr  )
static
COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setActive ( bool  bActive)

Definition at line 91 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setBlockedCommandList ( const char *  blockedCommandList)
COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setCompatFlag ( Compat  flag)

Set compatibility flags.

Definition at line 181 of file lok.cxx.

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

Set if we are painting the dialog.

Definition at line 121 of file lok.cxx.

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

Set the DPI scale for rendering for HiDPI displays.

Definition at line 131 of file lok.cxx.

References g_fDPIScale().

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setLanguageTag ( const LanguageTag rLanguageTag)

Update the current LOK's language.

Definition at line 197 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setLocale ( const LanguageTag rLanguageTag)

Update the current LOK's locale.

Definition at line 185 of file lok.cxx.

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 171 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 101 of file lok.cxx.

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

Set if we want range based header data.

Definition at line 151 of file lok.cxx.

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

Definition at line 262 of file lok.cxx.

References pStatusIndicatorCallback, and pStatusIndicatorCallbackData().

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setTiledAnnotations ( bool  bTiledAnnotations)

Set if we want no annotations rendering.

Definition at line 141 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setTiledPainting ( bool  bTiledPainting)

Set if we are doing tiled painting.

Definition at line 111 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::setViewIdForVisCursorInvalidation ( bool  bViewIdForVisCursorInvalidation)

Set whether clients want viewId in visible cursor invalidation payload.

Definition at line 156 of file lok.cxx.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::statusIndicatorFinish ( )

Definition at line 280 of file lok.cxx.

References Finish, pStatusIndicatorCallback, and pStatusIndicatorCallbackData().

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::statusIndicatorSetValue ( int  percent)

Definition at line 274 of file lok.cxx.

References pStatusIndicatorCallback, pStatusIndicatorCallbackData(), and SetValue.

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::statusIndicatorStart ( const OUString &  sText)

Definition at line 268 of file lok.cxx.

References pStatusIndicatorCallback, pStatusIndicatorCallbackData(), and Start.

Variable Documentation

LanguageAndLocale comphelper::LibreOfficeKit::g_aLanguageAndLocale
static

Definition at line 86 of file lok.cxx.

void(* comphelper::LibreOfficeKit::pStatusIndicatorCallback) (void *data, statusIndicatorCallbackType type, int percent, const char *pText)(nullptr)
static