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

Enumerations

enum class  statusIndicatorCallbackType {
  Start ,
  SetValue ,
  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 void * pStatusIndicatorCallbackData (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

◆ Compat

Enumerator
none 
scNoGridBackground 
scPrintTwipsMsgs 

Definition at line 77 of file lok.hxx.

◆ statusIndicatorCallbackType

Enumerator
Start 
SetValue 
Finish 

Definition at line 28 of file lok.hxx.

Function Documentation

◆ g_bActive()

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

Referenced by isActive(), and setActive().

◆ g_bDialogPainting()

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

◆ g_bLocalRendering()

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

◆ g_bPartInInvalidation()

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

◆ g_bRangeHeaders()

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

Referenced by isRangeHeaders(), and setRangeHeaders().

◆ g_bTiledAnnotations()

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

◆ g_bTiledPainting()

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

◆ g_bViewIdForVisCursorInvalidation()

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

◆ g_eCompatFlags()

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

Referenced by isCompatFlagSet(), and setCompatFlag().

◆ g_fDPIScale()

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

Scaling of the cairo canvas painting for hi-dpi.

Referenced by getDPIScale(), and setDPIScale().

◆ getDPIScale()

COMPHELPER_DLLPUBLIC double comphelper::LibreOfficeKit::getDPIScale ( )

Get the DPI scale for rendering for HiDPI displays.

Definition at line 135 of file lok.cxx.

References g_fDPIScale().

◆ getLanguageTag()

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

Get the current LOK's language.

Definition at line 201 of file lok.cxx.

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

◆ getLocale()

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

Get the current LOK's locale.

Definition at line 189 of file lok.cxx.

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

◆ isActive()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isActive ( )

Definition at line 95 of file lok.cxx.

References g_bActive().

Referenced by isAllowlistedLanguage().

◆ isAllowlistedLanguage()

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

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

Definition at line 208 of file lok.cxx.

References isActive(), and stream.

◆ isCompatFlagSet()

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

Get compatibility flags.

Definition at line 182 of file lok.cxx.

References g_eCompatFlags().

◆ isDialogPainting()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isDialogPainting ( )

Check if we are painting the dialog.

Definition at line 125 of file lok.cxx.

References g_bDialogPainting().

◆ isLocalRendering()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isLocalRendering ( )

Definition at line 175 of file lok.cxx.

References g_bLocalRendering().

◆ isPartInInvalidation()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isPartInInvalidation ( )

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

Definition at line 105 of file lok.cxx.

References g_bPartInInvalidation().

◆ isRangeHeaders()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isRangeHeaders ( )

Check if range based header data is enabled.

Definition at line 165 of file lok.cxx.

References g_bRangeHeaders().

◆ isTiledAnnotations()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isTiledAnnotations ( )

Check if annotations rendering is turned off.

Definition at line 145 of file lok.cxx.

References g_bTiledAnnotations().

◆ isTiledPainting()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isTiledPainting ( )

Check if we are doing tiled painting.

Definition at line 115 of file lok.cxx.

References g_bTiledPainting().

◆ isViewIdForVisCursorInvalidation()

COMPHELPER_DLLPUBLIC bool comphelper::LibreOfficeKit::isViewIdForVisCursorInvalidation ( )

Check whether clients want viewId in visible cursor invalidation payload.

Definition at line 160 of file lok.cxx.

References g_bViewIdForVisCursorInvalidation().

◆ pStatusIndicatorCallbackData()

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

◆ setActive()

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

Definition at line 90 of file lok.cxx.

References g_bActive().

◆ setBlockedCommandList()

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

◆ setCompatFlag()

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

Set compatibility flags.

Definition at line 180 of file lok.cxx.

References g_eCompatFlags().

◆ setDialogPainting()

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

Set if we are painting the dialog.

Definition at line 120 of file lok.cxx.

References g_bDialogPainting().

◆ setDPIScale()

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

Set the DPI scale for rendering for HiDPI displays.

Definition at line 130 of file lok.cxx.

References g_fDPIScale().

◆ setLanguageTag()

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

Update the current LOK's language.

Definition at line 196 of file lok.cxx.

References g_aLanguageAndLocale.

◆ setLocale()

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

Update the current LOK's locale.

Definition at line 184 of file lok.cxx.

References g_aLanguageAndLocale.

◆ setLocalRendering()

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

References g_bLocalRendering().

◆ setPartInInvalidation()

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

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

Definition at line 100 of file lok.cxx.

References g_bPartInInvalidation().

◆ setRangeHeaders()

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

Set if we want range based header data.

Definition at line 150 of file lok.cxx.

References g_bRangeHeaders().

◆ setStatusIndicatorCallback()

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

Definition at line 261 of file lok.cxx.

References pStatusIndicatorCallback, and pStatusIndicatorCallbackData().

◆ setTiledAnnotations()

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

Set if we want no annotations rendering.

Definition at line 140 of file lok.cxx.

References g_bTiledAnnotations().

◆ setTiledPainting()

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

Set if we are doing tiled painting.

Definition at line 110 of file lok.cxx.

References g_bTiledPainting().

◆ setViewIdForVisCursorInvalidation()

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

Set whether clients want viewId in visible cursor invalidation payload.

Definition at line 155 of file lok.cxx.

References g_bViewIdForVisCursorInvalidation().

◆ statusIndicatorFinish()

COMPHELPER_DLLPUBLIC void comphelper::LibreOfficeKit::statusIndicatorFinish ( )

Definition at line 279 of file lok.cxx.

References Finish, pStatusIndicatorCallback, and pStatusIndicatorCallbackData().

◆ statusIndicatorSetValue()

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

Definition at line 273 of file lok.cxx.

References percent, pStatusIndicatorCallback, pStatusIndicatorCallbackData(), and SetValue.

◆ statusIndicatorStart()

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

Definition at line 267 of file lok.cxx.

References pStatusIndicatorCallback, pStatusIndicatorCallbackData(), and Start.

Variable Documentation

◆ g_aLanguageAndLocale

LanguageAndLocale comphelper::LibreOfficeKit::g_aLanguageAndLocale
static

Definition at line 85 of file lok.cxx.

Referenced by getLanguageTag(), getLocale(), setLanguageTag(), and setLocale().

◆ pStatusIndicatorCallback

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