DbPlotSettingsValidator.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2024 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
 
 
 
#ifndef OD_DBPLOTSETVAL_H
#define OD_DBPLOTSETVAL_H
 
#include "RxObject.h"
#include "DbPlotSettings.h"
#include "OdArray.h"
 
class OdDbPlotSettings;
 
typedef OdDbPlotSettings::PlotPaperUnits PlotPaperUnits;
typedef OdDbPlotSettings::PlotRotation   PlotRotation;
typedef OdDbPlotSettings::PlotType       PlotType;
typedef OdDbPlotSettings::StdScaleType   StdScaleType;

class TOOLKIT_EXPORT OdDbPlotSettingsValidator : public OdRxObject
{
public:
  ODRX_DECLARE_MEMBERS(OdDbPlotSettingsValidator);

  virtual OdResult setPlotCfgName(
    OdDbPlotSettings* pPlotSettings,
    const OdString& plotDeviceName,
    const OdString& mediaName = OdString::kEmpty) = 0;

  virtual OdResult setCanonicalMediaName(
    OdDbPlotSettings* pPlotSettings,
    const OdString& mediaName) = 0;

  virtual OdResult setPlotOrigin(
    OdDbPlotSettings *pPlotSettings,
    double xCoordinate,
    double yCoordinate) = 0;
 

  virtual OdResult setPlotPaperUnits(
    OdDbPlotSettings* pPlotSettings,
    const PlotPaperUnits plotPaperUnits) = 0;
 

  virtual OdResult setPlotRotation(
    OdDbPlotSettings* pPlotSettings,
    const PlotRotation plotRotation) = 0;

  virtual OdResult setPlotCentered(
    OdDbPlotSettings* pPlotSettings,
    bool plotCentered) = 0;

  virtual OdResult setPlotType(
    OdDbPlotSettings* pPlotSettings,
    const PlotType plotType) = 0;

  virtual OdResult setPlotWindowArea(
    OdDbPlotSettings* pPlotSettings,
    double xMin,
    double yMin,
    double xMax,
    double yMax) = 0;

  virtual OdResult setPlotViewName(
    OdDbPlotSettings* pPlotSettings,
    const OdString& plotViewName) = 0;

  virtual OdResult setUseStandardScale(
    OdDbPlotSettings* pPlotSettings,
    bool useStandardScale) = 0;

  virtual OdResult setCustomPrintScale(
    OdDbPlotSettings* pPlotSettings,
    double numerator,
    double denominator) = 0;

  virtual OdResult setCurrentStyleSheet(
    OdDbPlotSettings* pPlotSettings,
    const OdString& currentStyleSheet) = 0;

  virtual OdResult setStdScaleType(
    OdDbPlotSettings* pPlotSettings,
    const StdScaleType stdScaleType) = 0;

  virtual OdResult setStdScale(
    OdDbPlotSettings* pPlotSettings,
    double standardScale) = 0;
  
//FELIX_CHANGE_BEGIN
protected:
  virtual void plotDeviceList(
    OdArray<const OdChar*> & deviceList) = 0;
  friend struct Helper;
public:
  struct Helper;
//FELIX_CHANGE_END

//FELIX_CHANGE_BEGIN
protected:
  virtual OdResult canonicalMediaNameList(
    OdDbPlotSettings* pPlotSettings,
    OdArray<const OdChar*> & mediaList) = 0;
public:
    //FELIX_CHANGE_END

  virtual OdString getLocaleMediaName(
    OdDbPlotSettings *pPlotSettings,
    const OdString&  canonicalName) = 0;

  virtual OdString getLocaleMediaName(
    OdDbPlotSettings *pPlotSettings,
    int mediaIndex) = 0;

   virtual OdResult setClosestMediaName(
    OdDbPlotSettings* pPlotSettings,
    double paperWidth,
    double paperHeight,
    const PlotPaperUnits plotPaperUnits,
    bool matchPrintableArea) = 0;

//FELIX_CHANGE_BEGIN
    virtual OdResult recalculatePlotData(OdDbPlotSettings* pPlotSet) = 0;
protected:
  virtual OdResult plotStyleSheetList(
    OdArray<const OdChar*> & styleList) = 0;
  friend class CExport2PDFDialog;
public:
//FELIX_CHANGE_END

//FELIX_CHANGE_BEGIN
protected:
  virtual void refreshLists(
    OdDbPlotSettings* pPlotSettings) = 0;
  friend TOOLKIT_EXPORT void fxRefreshLists( OdDbPlotSettingsValidator* p, OdDbPlotSettings* pPlotSettings );
public:
//FELIX_CHANGE_END
 

  virtual OdResult setZoomToPaperOnUpdate(
    OdDbPlotSettings* pPlotSettings,
    bool zoomToPaperOnUpdate) = 0;

  virtual OdResult setDefaultPlotConfig(
    OdDbPlotSettings* pPlotSettings) = 0;
 
//FELIX_CHANGE_BEGIN
#if !defined (SWIGWIN) && !defined (SWIG)
  virtual void plotDeviceList(OdArray<OdString> & deviceList) = 0;
  virtual OdResult canonicalMediaNameList(OdDbPlotSettings* pPlotSettings, OdArray<OdString> & mediaList) = 0;
  virtual OdResult plotStyleSheetList(OdArray<OdString> & styleList) = 0;
#endif
//FELIX_CHANGE_END
};

typedef OdSmartPtr<OdDbPlotSettingsValidator> OdDbPlotSettingsValidatorPtr;
 
//FELIX_CHANGE_BEGIN

TOOLKIT_EXPORT void fxRefreshLists( OdDbPlotSettingsValidator* p, OdDbPlotSettings* pPlotSettings );
 
#ifndef SWIG
class TOOLKIT_EXPORT OdDbPlotSettingsValidator2 : public OdDbPlotSettingsValidator
{
public:
    ODRX_DECLARE_MEMBERS(OdDbPlotSettingsValidator2);
 
    virtual OdResult setPlotViewId(
    OdDbPlotSettings* pPlotSet,
    const OdDbObjectId& id) = 0;
 
    virtual OdResult setPlotPaperSize(OdDbPlotSettings* pPlotSet, double paperWidth, double paperHeight) = 0;
    virtual OdResult setMargins(OdDbPlotSettings* pPlotSet, double leftMargin, double topMargin, double rightMargin, double bottomMargin)  = 0;
    virtual OdResult setStyleSheet(OdDbPlotSettings* pPlotSet, const OdString& styleSheetName) = 0;
 
    virtual OdResult recalculatePlotData(OdDbPlotSettings* pPlotSet) = 0;
    struct FlagResetter
    {
    friend class OdDbPlotSettingsValidatorImpl2;
    public:
        FlagResetter()
            : m_flags(0), m_value(0), m_or(true)
        {
        }
        FlagResetter(FlagResetter &rh)
            : m_flags(0), m_value(0), m_or(true)
        {
            this->operator=(rh);
        }
        FlagResetter(FlagResetter &&rh)
            : m_flags(0), m_value(0), m_or(true)
        {
            this->operator=(rh);
        }
        ~FlagResetter()
        {
            reset();
        }
        void operator = (FlagResetter &rh)
        {
            std::swap(m_flags, rh.m_flags);
            std::swap(m_value, rh.m_value);
            std::swap(m_or, rh.m_or);
        }
        void operator = (FlagResetter &&rh)
        {
            std::swap(m_flags, rh.m_flags);
            std::swap(m_value, rh.m_value);
            std::swap(m_or, rh.m_or);
        }
        void reset()
        {
            if (m_flags)
            {
                if (m_or)
                    *m_flags |= m_value;
                else
                    *m_flags &= ~m_value;
                m_flags = 0;
            }        }
    protected:
        FlagResetter(unsigned int &flags, unsigned int value, bool set) 
            : m_flags(&flags), m_value(value), m_or(!set)
        {
            if (m_or)
                *m_flags &= ~m_value;
            else
                *m_flags |= m_value;
        }
        unsigned int *m_flags, m_value;
        bool m_or;
    };
    virtual FlagResetter disablePlotDataRecomputation() = 0;
};
 
typedef OdSmartPtr<OdDbPlotSettingsValidator2> OdDbPlotSettingsValidator2Ptr;
#endif
//FELIX_CHANGE_END
 
 
#endif // OD_DBPLOTSETVAL_H