FxSystemServices.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted,
// provided that the above copyright notice appears in all copies and
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "DDKERNEL.h"
#include "FxUserIO.h"
#include "FxUI.h"
 
#include <DbHostAppServices.h>
 
#include "FxPragmaPush.h"
 
class CFxMainFrame;
class CFxDocumentManager;
class CFxHostAppServices;
class CFxLicenseInfo;
class QGLWidget;
class CFxProfileManager;
class CFxIO;
class CFxApplications;
class CFxVSTA;
class CFxUI;
class CFxNetworkAccessManager;
class CFxFileData;
class CFxObjectManager;
class CFxBagFiler;
class CFxInferencePointManager;
class QMimeData;
class CFxGeomUtils;
class CFxEvalModeHandler;
class CFxViewDrawInfo;
class CXeRemoteFileManager;
class CFxSelectionSetFilterHolder;
class CFxTrackerData;
class CXeStorageServices;
class CXeHostServices;
class CFxAPI;
class CFxOutputDevice;
 
struct IDispatch;
 
class CFxVectorizeDevice;
typedef OdSmartPtr<CFxVectorizeDevice> CFxVectorizeDevicePtr;
 
class OdGiRasterImage;
typedef OdSmartPtr<OdGiRasterImage> OdGiRasterImagePtr;
 
class CFxGeometryClipper;
typedef OdSmartPtr<CFxGeometryClipper> CFxGeometryClipperPtr;
 
class CFxDatabase;
typedef OdSmartPtr<CFxDatabase> CFxDatabasePtr;
 
class CFxRasterImage;
typedef OdSmartPtr<CFxRasterImage> CFxRasterImagePtr;
 
typedef OdArray<const OdGiDrawable*> OdGiDrawableArray;
 
class CFxActionMacroManager;

class DDKERNEL_API CFxSystemServices
{
public:

 
    enum FxMessageBoxFlags
    {
        MBButtonOk                = 0x00000000L,
        MBButtonOkCancel          = 0x00000001L,
        MBButtonAbortRetryIgnore  = 0x00000002L,
        MBButtonYesNoCancel       = 0x00000003L,
        MBButtonYesNo             = 0x00000004L,
        MBButtonRetryCancel       = 0x00000005L,
        MBButtonSaveDiscardCancel = 0x00000009L,
        MBIconStop                = 0x00000010L,
        MBIconQuestion            = 0x00000020L,
        MBIconExclamation         = 0x00000030L,
        MBIconAsterisk            = 0x00000040L,
        MBModalSystem             = 0x00001000L,
        MBModalTask               = 0x00002000L
    };
 
    CFxSystemServices();
 
    virtual ~CFxSystemServices();

    virtual bool GetPassword(const CFxString& dwgName, bool isXref, OdPassword& password) const  = 0;
 

    virtual void AuditPrintReport(OdDbAuditInfo* pAuditInfo, const CFxString& str) const = 0;

    virtual CFxString FindFile( const CFxString& sFile, bool bDisplayMessage = false, const OdDbBaseDatabase* pDb = 0, OdDbHostAppServices::FindFileHint hint = OdDbHostAppServices::kDefault) const  = 0;

    virtual bool IsValidFileName( const CFxString& fileName ) const = 0;

    virtual void Write( const CFxString& str, const CFxDocument* pContext = 0 ) const = 0;

    virtual void WriteLine( const CFxString& str, const CFxDocument* pContext = 0, bool bShowCommandWindowOutput = false ) const = 0;

    virtual CFxMainFrame* GetMainFrame() const = 0;

    virtual int MessageBox( const CFxString& csText, const CFxString& csCaption, unsigned int uType) const = 0;

    virtual CFxDocumentManager* GetFxDocumentManager() noexcept = 0;

    virtual CFxHostAppServices* GetHostAppServices() noexcept = 0;

    virtual OdDbSystemServices* GetSystemServices() noexcept = 0;

    virtual CFxEvalModeHandler* GetFxEvalModeHandler() noexcept = 0;

    class DDKERNEL_API CFxExpressionParserData
    {
    public:
        /* {secret} */
        CFxExpressionParserData();
        /* {secret} */
        ~CFxExpressionParserData();

        bool m_bSuppressSystemOutput;

        bool m_bSuppressCommandOutput;

        bool m_bSuppressCommandNames;

        bool m_bIgnoreLISP;

        bool m_bIgnoreMacroSymbols;

        bool m_bDisableHistory;

        bool m_bSelectionSetModificationsProhibited;

        bool m_bIgnoreDoubleQuotes;

        bool m_bHiddenCommandAllowed;

        bool m_bUCS;

        bool m_bLispResultWanted;

        bool m_bIgnoreWhiteSpace;

        bool m_bContinuousCommand;
 
        bool m_bUsePickFirst;
 
        bool m_bUseHoverSelection;
    };

    virtual OdResBufPtr SendStringToExecute( const CFxString& strCommand, const CFxExpressionParserData* pData = 0 ) = 0;
 
    virtual OdResBufPtr SendStringToExecute( const CFxExpressionParserData* pData, int rtype, ... ) = 0;//variable argument list
 
    virtual OdResBufPtr SendStringToExecute( const CFxExpressionParserData* pData, int rtype, va_list vaList ) = 0;//variable argument list
 
    virtual OdResBufPtr SendStringToExecute( const CFxExpressionParserData* pData, OdResBufPtr pResbuf ) = 0;
 
    virtual OdResBufPtr SendStringToExecute( CFxDocument* pDoc, const CFxExpressionParserData* pData, OdResBufPtr pResbuf ) = 0;
 
    virtual void QueueExpr( const CFxExpressionParserData* pData, const OdResBufPtr& pExpr ) = 0;
    virtual void QueueExpr( const CFxExpressionParserData* pData, int rtype, ... ) = 0;

    virtual CFxVectorizeDevicePtr GetFxGDIDevice() = 0;

    virtual OdGiRasterImagePtr CreateRasterImage() const = 0;

    typedef enum _FontType
    {
        eFontsAll = 0,
        eFontsSHX = 1,
        eFontsTTF = 2
    } FontType;

 
    virtual OdArray<CFxString> GetAvailableFonts( FontType eType ) const = 0;

    virtual CFxProfileManager* GetFxProfileManager() = 0;

    virtual CFxIO* GetFxIO() = 0;

    virtual CFxApplications* GetFxApplications() noexcept = 0;
    virtual CFxVSTA* GetVSTA() = 0;
    virtual void ActivateRibbon( bool enable ) = 0;

    virtual IDispatch* GetIApplication() = 0;

    virtual int FileDialog(
        CFxUserIO::FileNameRetVal* pResultMode,
        CFxString* pResultStr,
        FxWId parent,
        CFxUserIO::FileNameType eType,
        const CFxString& dialogCaption,
        const CFxString& defaultExtension,
        const CFxString& filter,
        const CFxString& initialDir,
        int* filterIndex = 0, // filterIndex is zero-based
        CFxString* templateName = 0,
        CFxUserIO::FileNameFlags flags = CFxUserIO::eFileNameNoFlags,
        OdCodePageId** codepage = 0) = 0;

    virtual int FileDialog(
        CFxUserIO::FileNameRetVal* pResultMode,
        CFxStringArray* pResultStrs,
        FxWId parent,
        CFxUserIO::FileNameType eType,
        const CFxString& dialogCaption,
        const CFxString& defaultExtension,
        const CFxString& filter,
        const CFxString& initialDir,
        int* filterIndex = 0, // filterIndex is zero-based
        CFxString* templateName = 0,
        CFxUserIO::FileNameFlags flags = CFxUserIO::eFileNameNoFlags,
        OdCodePageId** codepage = 0) = 0;
 
    virtual int FolderDialog( const CFxString& dialogCaption,
                              const CFxString& defaultDirectoryName,
                              CFxString* pResultStr,
                              FxWId parent ) = 0;

    virtual CFxUI* GetFxUI() = 0;

    virtual void Help( const CFxString& lpCommandName ) const = 0;

    virtual void ExitApplication( int nReturnCode = 0 ) = 0;

    virtual bool IsApplicationExiting( ) const = 0;

    virtual CFxNetworkAccessManager * GetFxNetworkAccessManager( ) = 0;

//    virtual CFxExtentsAccumulator* CreateExtentsAccumulator() = 0;

    virtual CFxGeometryClipperPtr CreateGeometryClipper() = 0;
 
    typedef enum
    {
        kDirOpen,
        kDirAttach,
        kDirInsert,
        kDirLoadShape,
        kDirLoadScript,
        kDirLisp,
        kDirSave,
        kDirPrint
    } InitialDir;

    virtual void GetInitialDirPath( InitialDir type, CFxString& initialDir, const CFxFileData* info = 0 ) const = 0;

    virtual void SetInitialDirPath( InitialDir type, const CFxString& fileNamePath ) = 0;

    virtual CFxObjectManager* GetObjectManager() = 0;

    virtual OdSmartPtr<CFxBagFiler> CreateBagFiler(
        OdDbDatabase* db,
        OdDb::DwgVersion version = OdDb::kDHL_CURRENT,
        fdt_resbufW* resBuf = 0,
        bool bIncludesDefaultValues = false) = 0;

    virtual bool userBreak() = 0;

    virtual void SetUserBreak( bool bUserBreak = true ) = 0;

    virtual CFxInferencePointManager* GetInferencePointManager() = 0;

    virtual OdCodePageId GetSystemCodepage() const = 0;

    virtual void SetSystemCodepage( OdCodePageId codepage ) = 0;

    virtual bool DoVerb( const OdDbObjectId& idOleObject ) const = 0;

    virtual bool AddOleDataToClipboard( QMimeData* pClipboardData, CFxDatabasePtr pData, int iFrameWidth, int iFrameHeight ) const = 0;

    virtual CFxGeomUtils* GetGeomUtils() const = 0;

    typedef enum _ModelerType
    {
        kNoModeler      = 0,
        kOdaModeler     = 1,
        kSpatialACIS    = 2,
        kUnknownModeler = 3
    } ModelerType;

    virtual ModelerType GetModelerManufacture() const = 0;

    virtual bool GetVersion( int* major, int* minor, int* product, int* build ) const = 0;

    virtual CFxString GetVersion() const = 0;

    virtual void SetOEMVersion( const CFxString& sOEMVersion ) = 0;

    virtual CFxString GetOEMVersion() const = 0;

    virtual CFxString GetAppDataVersion() const = 0;

    virtual CFxString GetOpenDefaultExtension() const = 0;

    virtual void DisableUI(bool disable, bool includeCommandWindow = true, bool includeDocumentWindows = true, bool includeStatusBar = true ) = 0;

    virtual void AuthoriseOEMModule(bool authorise) = 0;

    virtual bool IsOEMModuleAuthorised() = 0;

    virtual CFxActionMacroManager* GetFxActionMacroManager() = 0;

    virtual const CFxActionMacroManager* GetFxActionMacroManager() const = 0;

    virtual CFxRasterImagePtr CreateDrawablePreview( OdUInt32 iWidth, OdUInt32 iHeight, OdDbDatabase* pDatabase, const OdGiDrawableArray& drawables, const CFxViewDrawInfo* pInfo ) = 0;

    virtual CFxAPI* GetFxAPI(CFxDocument * pDocument) = 0;

    virtual void StopATFBomb() = 0;
 
    virtual CFxUIStyle::UIStyle GetRibbonTheme() const = 0;
    virtual void SetRibbonTheme( const CFxUIStyle::UIStyle value ) = 0;

    virtual void AddOutputDevice(CFxOutputDevice *device) = 0;

    virtual void RemoveOutputDevice(CFxOutputDevice *device) = 0;

    virtual OdResBufPtr ExecuteStringOnPause( CFxDocument* pDoc, const CFxString& strCommand, const CFxExpressionParserData* pData = 0 ) = 0;
};

DDKERNEL_API CFxSystemServices* GetFxSystemServices() noexcept;
 
#include "FxPragmaPop.h"