AcDbLayoutManager.h

Go to the documentation of this file.

#pragma once
 
//
// (C) Copyright 2005-2024 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.
 
#include "AcRTTIObject.h"
 
class ARX_API AcDbLayoutManager : public AcRxObject
{
public:
    ACRX_DECLARE_MEMBERS(AcDbLayoutManager);
    const ACHAR * findActiveLayout(bool, AcDbDatabase const * = NULL);
#ifdef FXARX2018
    AcDbObjectId  findLayoutNamed(const ACHAR*, AcDbDatabase const * = NULL);
#else
    AcDbLayout*   findLayoutNamed(const ACHAR *, bool = false, const AcDbDatabase* = NULL);
#endif
 
    void addReactor(AcDbLayoutManagerReactor*);
    void removeReactor(AcDbLayoutManagerReactor*);
    virtual AcDbObjectId getActiveLayoutBTRId(AcDbDatabase const * = NULL);
    bool layoutExists(wchar_t const *, const AcDbDatabase* = NULL);
 
    Acad::ErrorStatus getLayoutNamed(const ACHAR*, AcDbLayout*&, AcDb::OpenMode = AcDb::kForRead, const AcDbDatabase* = nullptr);
    virtual Acad::ErrorStatus setCurrentLayout(const ACHAR *, AcDbDatabase* = NULL);
    virtual Acad::ErrorStatus setCurrentLayoutId(AcDbObjectId);
    virtual Acad::ErrorStatus deleteLayout(const ACHAR *, AcDbDatabase* = NULL);
    virtual Acad::ErrorStatus createLayout(const ACHAR *, AcDbObjectId&, AcDbObjectId&, AcDbDatabase* = NULL);
    virtual int countLayouts(AcDbDatabase * = NULL);
    virtual Acad::ErrorStatus copyLayout(const ACHAR *, const ACHAR *, AcDbDatabase* = NULL);
    virtual Acad::ErrorStatus renameLayout(const ACHAR *, const ACHAR *, AcDbDatabase* = NULL);
    virtual Acad::ErrorStatus cloneLayout(AcDbLayout*, const ACHAR *, int = 0, AcDbDatabase* = NULL);
    virtual AcDbObjectId getNonRectVPIdFromClipId(AcDbObjectId);
    virtual bool isVpnumClipped(int , const AcDbDatabase* = NULL);
};
 
class AcApLayoutManager : public AcDbLayoutManager
{
public:
    virtual int pageSetup(AcDbObjectId = AcDbObjectId::kNull, void* pParent = NULL, Adesk::Boolean = TRUE);
    virtual void updateCurrentPaper(Adesk::Boolean = FALSE);
    virtual void updateLayoutTabs();
    virtual const ACHAR * findActiveTab();
    virtual Adesk::Boolean showTabs();
    virtual void setShowTabs(Adesk::Boolean);
    virtual Adesk::Boolean showPageSetup();
    virtual void setShowPageSetup(Adesk::Boolean);
    virtual Adesk::Boolean createViewports();
    virtual void setCreateViewports(Adesk::Boolean);
    virtual Adesk::Boolean showPaperBackground();
    virtual void setShowPaperBackground(Adesk::Boolean);
    virtual Adesk::Boolean showPaperMargins();
    virtual void setShowPaperMargins(Adesk::Boolean);
    virtual Adesk::Boolean showPrintBorder();
    virtual void setShowPrintBorder(Adesk::Boolean);
    virtual ACHAR * getNextNewLayoutName(AcDbDatabase* = NULL);
    virtual void  setDefaultPlotConfig(AcDbObjectId);
    virtual Acad::ErrorStatus getClipBoundaryElaboration(AcDbObjectId, AcGePoint2dArray *&);
    virtual Acad::ErrorStatus pointInViewports(const AcGePoint3d &, AcDbObjectIdArray &);
};