lok.hxx

Go to the documentation of this file.

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
#ifndef INCLUDED_COMPHELPER_LOK_HXX
#define INCLUDED_COMPHELPER_LOK_HXX
 
#include <comphelper/comphelperdllapi.h>
#include <rtl/ustring.hxx>
 
class LanguageTag;
 
// Interface between the LibreOfficeKit implementation called by LibreOfficeKit clients and other
// LibreOffice code.
 
namespace comphelper::LibreOfficeKit
{
// Functions to be called only from the LibreOfficeKit implementation in desktop, not from other
// places in LibreOffice code.
 
COMPHELPER_DLLPUBLIC void setActive(bool bActive = true);
 
enum class statusIndicatorCallbackType
{
    Start,
    SetValue,
    Finish
};
 
COMPHELPER_DLLPUBLIC void setStatusIndicatorCallback(
    void (*callback)(void* data, statusIndicatorCallbackType type, int percent, const char* pText),
    void* data);
 
// Functions that can be called from arbitrary places in LibreOffice.
 
// Check whether the code is running as invoked through LibreOfficeKit.
COMPHELPER_DLLPUBLIC bool isActive();
 
COMPHELPER_DLLPUBLIC void setLocalRendering(bool bLocalRendering = true);
COMPHELPER_DLLPUBLIC bool isLocalRendering();
 
COMPHELPER_DLLPUBLIC bool isPartInInvalidation();
COMPHELPER_DLLPUBLIC void setPartInInvalidation(bool bPartInInvalidation);
 
COMPHELPER_DLLPUBLIC bool isTiledPainting();
COMPHELPER_DLLPUBLIC void setTiledPainting(bool bTiledPainting);
COMPHELPER_DLLPUBLIC bool isDialogPainting();
COMPHELPER_DLLPUBLIC void setDialogPainting(bool bDialogPainting);
COMPHELPER_DLLPUBLIC void setDPIScale(double fDPIScale);
COMPHELPER_DLLPUBLIC double getDPIScale();
COMPHELPER_DLLPUBLIC void setTiledAnnotations(bool bTiledAnnotations);
COMPHELPER_DLLPUBLIC bool isTiledAnnotations();
COMPHELPER_DLLPUBLIC void setRangeHeaders(bool bTiledAnnotations);
COMPHELPER_DLLPUBLIC bool isRangeHeaders();
 
enum Compat : sal_uInt32
{
    none = 0,
    scNoGridBackground = 1,
    scPrintTwipsMsgs = 2,
};
COMPHELPER_DLLPUBLIC void setCompatFlag(Compat flag);
COMPHELPER_DLLPUBLIC bool isCompatFlagSet(Compat flag);
COMPHELPER_DLLPUBLIC void resetCompatFlag();
 
COMPHELPER_DLLPUBLIC bool isViewIdForVisCursorInvalidation();
COMPHELPER_DLLPUBLIC void setViewIdForVisCursorInvalidation(bool bViewIdForVisCursorInvalidation);
 
COMPHELPER_DLLPUBLIC void setLocale(const LanguageTag& languageTag);
COMPHELPER_DLLPUBLIC const LanguageTag& getLocale();
 
COMPHELPER_DLLPUBLIC void setLanguageTag(const LanguageTag& languageTag);
COMPHELPER_DLLPUBLIC const LanguageTag& getLanguageTag();
COMPHELPER_DLLPUBLIC bool isAllowlistedLanguage(const OUString& lang);
 
COMPHELPER_DLLPUBLIC void setTimezone(bool isSet, const OUString& rTimezone);
 
// Status indicator handling. Even if in theory there could be several status indicators active at
// the same time, in practice there is only one at a time, so we don't handle any identification of
// status indicator in this API.
COMPHELPER_DLLPUBLIC void statusIndicatorStart(const OUString& sText);
COMPHELPER_DLLPUBLIC void statusIndicatorSetValue(int percent);
COMPHELPER_DLLPUBLIC void statusIndicatorFinish();
 
COMPHELPER_DLLPUBLIC void setBlockedCommandList(const char* blockedCommandList);
}
 
#endif // INCLUDED_COMPHELPER_LOK_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */