FxUserIO.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 "FxPragmaPush.h"
 
#include "DDKERNEL.h"
#include "FxSelectionSet.h"
#include "FxString.h"
#include "FxPlatformSettings.h"
#include "FxViewDrawInfo.h"
#include "FxNoteEditorConfig.h"
 
#include <DbUserIO.h>
#include <Gi/GiDrawableImpl.h>
 
class CFxTracker;
class CFxKeywordArray;
class CFxUnitsFormatter;
class OdEdCommandContext;

class DDKERNEL_API CFxEdInputTracker:
    public OdStaticRxObject< OdEdInputTracker >,
    public OdStaticRxObject< OdGiDrawableImpl<OdGiDrawable> >
{
public:
    CFxEdInputTracker();

    virtual bool IsDrawInAllViewports() const;

    FX_VIRTUAL OdUInt32 subSetAttributes( OdGiDrawableTraits* pTraits ) const override;

    FX_VIRTUAL bool subWorldDraw( OdGiWorldDraw* pWorldDraw ) const override;
 

    virtual const OdGiDrawable* drawable() const;

    virtual void setValue( const OdGePoint3d& value ) = 0;

    virtual void setValueFinal( const OdGePoint3d& value );

    virtual bool IsSuitableForContext( const CFxView* pFxView ) const;

    virtual const CFxDocument* GetFxDocument() const;

    virtual OdGePlane GetWorkingPlane() const;

    virtual void EnablePreview( bool bVal );
 
    virtual bool IsPreviewEnabled() const;

    virtual const CFxString& GetName() const;

    virtual CFxViewDrawInfo::DrawDecoration GetDrawDecoration() const;
 
protected:
    /* {secret} */
    FX_VIRTUAL int addDrawables(OdGsView* pView) override;
    FX_VIRTUAL void removeDrawables(OdGsView* pView) override;
 
    bool    m_bDrawPreview;
    CFxString m_strName;
};
 
 
typedef std::vector<CFxTracker*> TRACKER_VECTOR;

class DDKERNEL_API CFxUserIO : public OdStaticRxObject<OdDbUserIO>
{
    friend class CFxCommandParser;
 
public:
    /* {secret} */
    CFxUserIO();
 
    /* {secret} */
    ~CFxUserIO() override;

    virtual void Write( const CFxString& prompt );

    typedef enum _SelectMode
    {
        eNormal                    = 1,
        ePickFirst                 ,
        eCrossing                  ,
        eObjectClassification      ,
        eCrossingPolygon           ,
        eFence                     ,
        eLast                      ,
        ePrevious                  ,
        eWindow                    ,
        eWindowPolygon             ,
        eFilter                    ,
        eBox                       ,
        eGroup                     ,
        eByPoint                   ,
        eLasso                     ,
        eSingleMode                 = 0x100,
        eSubobjects                 = 0x200,
        eEverythingInAperture       = 0x400,
    } SelectMode;

    typedef enum _Keywords
    {
        eKwNone     = 0x0,
        eKwWindow   = 0x1,
        eKwLast     = 0x2,
        eKwCrossing = 0x4,
        eKwALL      = 0x8,
        eKwBOX      = 0x10,
        eKwFence    = 0x20,
        eKwWPolygon = 0x40,
        eKwCPolygon = 0x80,
        eKwGroup    = 0x100,
        eKwEntSel   = eKwLast,
        eKwNEntSel  = eKwNone
    } Keywords;

    typedef enum _KeywordsEx
    {
        eKwAdd          = 0x1000,
        eKwRemove       = 0x2000,
        eKwMultiple     = 0x4000,
        eKwPrevious     = 0x8000,
        eKwUndo         = 0x10000,
        eKwAUto         = 0x20000,
        eKwSIngle       = 0x40000,
        eKwSUbobject    = 0x80000,
        eKwObject       = 0x100000,
        eKwSSGet        = eKwWindow | eKwLast | eKwCrossing | eKwALL | eKwBOX | eKwFence | eKwWPolygon | eKwCPolygon | eKwGroup |
                          eKwAdd | eKwRemove | eKwMultiple | eKwPrevious | eKwUndo | eKwAUto | eKwSIngle
    } KeywordsEx;

    virtual int DoSSGet(
        SelectMode eMode,
        CFxSelectionSet* pSelectionSet,
        int keywords = eKwSSGet,
        const CFxString& sSelectPrompt = CFxString(),
        const CFxString& sRemovePrompt = CFxString(),
        const fdt_resbufW* pFilter = 0,
        OdGePoint3dArray* pickPointsWCS = 0,
        bool bSingleMode = false,
        CFxSelectionSet::RemoveFlags flags = CFxSelectionSet::eRemoveDefaultInvalid,
        TRACKER_VECTOR* pTrackers = 0 ) = 0;

    virtual int DoEntsel(
        const CFxString& sPrompt,
        CFxSelectionSet* pSelectionSet,
        const fdt_resbufW* pFilter,
        OdGePoint3d& pickPointWCS,
        bool& bPointInput,
        int keywords = eKwEntSel,
        CFxSelectionSet::RemoveFlags flags = CFxSelectionSet::eRemoveDefaultInvalid,
        TRACKER_VECTOR* pTrackers = 0 ) = 0;

    virtual int DoNentsel(
        const CFxString& sPrompt,
        CFxSelectionSet* pSelectionSet,
        const fdt_resbufW* pFilter,
        OdGePoint3d& pickPointWCS,
        int pickflag,
        OdGeMatrix3d& modelToWorld,
        OdDbObjectIdArray& containerBlocks,
        int keywords = eKwNEntSel,
        CFxSelectionSet::RemoveFlags flags = CFxSelectionSet::eRemoveDefaultInvalid,
        TRACKER_VECTOR* pTrackers = 0 ) = 0;

    virtual int GetUserInput(
        CFxString* pInput) = 0;

    virtual const CFxString& GetUserInput() const = 0;

    virtual int GetPoint(
        const CFxString& sPrompt,
        const OdGePoint3d* pDefaultValue,
        const OdGePoint3d* pBasePointWCS,
        OdGePoint3d* pReturnValueWCS,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        bool bDoNotShowBasePointLine = false,
        TRACKER_VECTOR* pTrackers = 0,
        const OdGePlane* pPlane = 0) = 0;

    virtual int GetString(
        bool bIgnoreSpaces,
        const CFxString& sPrompt,
        const CFxString& sDefaultVal,
        CFxString* pResult,
        CFxEdInputTracker* pTracker = 0,
        TRACKER_VECTOR* pTrackers = 0 ) = 0;

    virtual int GetKeyword(
        const CFxString& sPrompt,
        const CFxString& sDefault,
        CFxString* pResult,
        CFxEdInputTracker* pTracker = 0,
        TRACKER_VECTOR* pTrackers = 0 ) = 0;

    template< class T >
    struct CFxRange
    {
    public:
        T m_Min;
        T m_Max;
    };

    virtual int GetDouble(
        const CFxString& sPrompt,
        const double* pDefaultVal,
        double* pResult,
        CFxRange<double>* pRange = 0,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        TRACKER_VECTOR* pTrackers = 0 ) = 0;

    virtual int GetInt(
        const CFxString& prompt,
        const int* pDefaultVal,
        int* pResult,
        CFxRange<int>* pRange = 0,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        TRACKER_VECTOR* pTrackers = 0 ) = 0;

    virtual int GetAngle(
        const CFxString& prompt,
        const double* pDefaultValue,
        const OdGePoint3d* pBasePointWCS,
        double* pResult,
        CFxRange<double>* pRange = 0,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        bool bDoNotShowBasePointLine = false,
        TRACKER_VECTOR* pTrackers = 0,
        const OdGePlane* pPlane = 0) = 0;

    virtual int GetDirection(
        const CFxString& prompt,
        const double* pDefaultValue,
        const OdGePoint3d* pBasePointWCS,
        double* pResult,
        CFxRange<double>* pRange = 0,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        bool bDoNotShowBasePointLine = false,
        TRACKER_VECTOR* pTrackers = 0,
        const OdGePlane* pPlane = 0) = 0;

    virtual int GetOrient(
        const CFxString& prompt,
        const double* pDefaultValue,
        const OdGePoint3d* pBasePtWCS,
        double* pResult,
        CFxRange<double>* pRange = 0,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        bool bDoNotShowBasePointLine = false,
        TRACKER_VECTOR* pTrackers = 0,
        const OdGePlane* pPlane = 0) = 0;

    virtual int GetCorner(
        const CFxString& prompt,
        const OdGePoint3d* pDefaultValue,
        const OdGePoint3d* pBasePtWCS,
        OdGePoint3d* pResult,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        TRACKER_VECTOR* pTrackers = 0,
        const OdGePlane* pPlane = 0) = 0;

    virtual int GetDist(
        const CFxString& prompt,
        const double* pDefaultValue,
        const OdGePoint3d* pBasePtWCS,
        double* pResult,
        CFxRange<double>* pRange = 0,
        CFxEdInputTracker* pTracker = 0,
        const CFxString& errorPrompt = CFxString(),
        bool bDoNotShowBasePointLine = false,
        TRACKER_VECTOR* pTrackers = 0,
        const OdGePlane* pPlane = 0) = 0;

    virtual int GetNoteEditor(
        OdDbEntityPtr & EntType,
        CFxNoteEditorConfigPtr config,
        int iHelpID,
        const CFxString & errorPrompt = CFxString(),
        TRACKER_VECTOR * pTrackers = nullptr,
        const OdGePlane * pPlane = nullptr,
        bool bPinToOldLocation = false ) = 0;

    virtual int GetNoteEditor(
        OdDbEntityPtr& EntType,
        int nFlag,
        int iHelpID,
        const CFxString& errorPrompt = CFxString(),
        TRACKER_VECTOR* pTrackers = nullptr,
        const OdGePlane* pPlane = nullptr,
        bool bPinToOldLocation = false ) = 0;

    typedef enum _FileNameFlags
    {
        eFileNameNoFlags    = 0,
        eFileNameHaveMenu   = 1
    } FileNameFlags;

    typedef enum _FileNameType
    {
        eTypeFilter                = 0x000000FF,
        eNew                    = 0x00000001,
        eOpen                    = 0x00000002,
        eSave                    = 0x00000004,
        eOpenFolder             = 0x00000008,
 
        eOpenFilter                = 0x0000FF00,
        eOpenNoPreview            = 0x00000100,
        eOpenNoReadOnly            = 0x00000200,
        eOpenNoTemplateHandling = 0x00000400,
 
        eOpenNotExist           = 0x00000800,
    } FileNameType;

    typedef enum _FileNameRetVal
    {
        eFileNew                    = 0x000001,
        eFileNewNoTemplateImperial  = 0x000002,
        eFileNewNoTemplateMetric    = 0x000003,
 
        eFileOpen                   = 0x000100,
        eFileOpenReadOnly           = 0x000300,
 
        eFileSave                   = 0x010000,
    } FileNameRetVal;
 
    typedef std::vector<CFxUserIO::FileNameRetVal> FileNameRetValArray;

    static int GetFileNameStatic_Obsolete(
        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,
        FileNameFlags flags = eFileNameNoFlags,
        OdCodePageId** pCodepage = 0);

    static int GetFileNamesStatic_Obsolete(
        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,
        FileNameFlags flags = eFileNameNoFlags,
        OdCodePageId** pCodepage = 0);

    virtual int GetFileName(
        bool &bFILEDIA,
        const CFxString& prompt,
        const CFxString& defaultFileName,
        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,
        FileNameFlags flags = eFileNameNoFlags,
        OdCodePageId** codepage = 0 ) = 0;

    virtual int GetFileNames(
        bool &bFILEDIA,
        const CFxString& prompt,
        const CFxString& defaultFileName,
        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,
        FileNameFlags flags = eFileNameNoFlags,
        OdCodePageId** codepage = 0 ) = 0;

    virtual int MessageBox(
        bool bFILEDIA,
        const CFxString& prompt,
        const CFxString& caption,
        unsigned int uType ) = 0;

    virtual void Initget( int iFlags ) = 0;

    virtual void Initget (
        int iFlags,
        const CFxStringArray& keywordsGlobal,
        const CFxStringArray& keywordsLocal ) = 0;

    virtual void Initget(
        int iFlags,
        const CFxKeywordArray& keywords ) = 0;

    virtual void SetIsPrintSelectResults( bool value ) = 0;

    virtual const CFxUnitsFormatter* GetUnitsFormatter() const = 0;

    virtual void SetPromptExplanation( const CFxString& explanation ) = 0;

    virtual CFxString GetPrompt( const CFxString& prompt ) const = 0;

    virtual CFxString GetPrompt( const CFxString& prompt, const CFxString& range ) const = 0;

    virtual CFxString GetPromptPoint( const CFxString& prompt, const OdGePoint2d* pDefaultValue ) const = 0;

    virtual CFxString GetPromptPoint( const CFxString& prompt, const OdGePoint3d* pDefaultValue ) const = 0;

    virtual CFxString GetPromptString( const CFxString& prompt, const CFxString* pDefaultValue ) const = 0;

    virtual CFxString GetPromptString( const CFxString& prompt, const CFxString* pDefaultValue, const CFxString& range ) const = 0;

    virtual CFxString GetPromptDist( const CFxString& prompt, const double* pDefaultValue ) const = 0;

    virtual CFxString GetPromptReal( const CFxString& prompt, const double* pDefaultValue ) const = 0;

    virtual CFxString GetPromptAngle( const CFxString& prompt, const double* pDefaultValue, bool ignoreANGBASE = false ) const = 0;

    virtual CFxString GetPromptInt( const CFxString& prompt, const int* pDefaultValue ) const = 0;

    virtual CFxString GetPromptInt( const CFxString& prompt, const int* pDefaultValue, const CFxString& range ) const = 0;

    virtual CFxString GetPromptKeyword( const CFxString* pDefaultValue = 0, const CFxString* pOptionDescription = 0 ) const = 0;

    virtual CFxString GetPromptKeyword( const CFxString& prompt, const CFxString* pDefaultValue = 0 ) const = 0;

    virtual void MessageLoop_Obsolete(
        bool bClickAllowed,
        bool bIgnoreWhiteSpaces,
        CFxTracker* pInputTracker,
        OdResBufPtr& pInput,
        TRACKER_VECTOR* pTrackers ) = 0;

   virtual const CFxSelectionSet* GetPreviousSelectionSet() const = 0;

    virtual void SetPreviousSelectionSet(const OdDbObjectIdArray& ids) = 0;

    virtual void SetPreviousSelectionSet( const CFxSelectionSet* pSourceSet ) = 0;

    virtual int GetZoomScale( double* pScale, const CFxString& userInput, const CFxView* pView ) const = 0;

    virtual CFxSelectionSet* GetFxCurrentSelectionSet() = 0;

    virtual bool IsPending() const = 0;

    virtual int InitgetFlags() const = 0;

    virtual const CFxString& GetActivePrompt() const = 0;

    virtual void SetCurrentPrompt( const CFxString& prompt, bool bWrite = false ) = 0;

    virtual const CFxStringArray& GetActiveGlobalKeywords( CFxStringArray& activeGlobalAbbreviations ) const = 0;

    virtual const CFxStringArray& GetActiveLocalKeywords( CFxStringArray& activeLocalAbbreviations ) const = 0;

    virtual int GetFolderPath( const CFxString& dialogCaption,
                               const CFxString& defaultDirectoryName,
                               CFxString* pResultStr,
                               FxWId parent ) = 0;
    
protected:
 
    //DWGDirect overridden functions
    /* {secret} */
    OdGePoint3d getPoint(const OdString& prompt,
        int options = OdEd::kGptDefault,
        const OdGePoint3d* pDefaultValue  = 0,
        const OdString& keywords = OdString::kEmpty,
        OdEdPointTracker* pTracker = 0) override = 0;
 
    /* {secret} */
    double getAngle(const OdString& prompt,
        int options = OdEd::kInpDefault,
        double defaultValue = 0.0,
        const OdString& keywords = OdString::kEmpty,
        OdEdRealTracker* pTracker = 0) override = 0;
 
    /* {secret} */
    double getDist(const OdString& prompt,
        int options = OdEd::kInpDefault,
        double defaultValue = 0.0,
        const OdString& keywords = OdString::kEmpty,
        OdEdRealTracker* pTracker = 0) override = 0;
 
    /* {secret} */
    OdCmColor getColor(const OdString& prompt,
        int options = OdEd::kInpDefault,
        const OdCmColor* pDefaultValue = 0,
        const OdString& keywords = OdString::kEmpty,
        OdEdColorTracker* pTracker = 0) override = 0;
 
    /* {secret} */
#if TD_VERSION >= 40301
    OdSelectionSetPtr select( const OdString& prompt = OdString::kEmpty,
        int options = OdEd::kSelDefault,
        const OdSelectionSet* pDefaultValue = 0,
        const OdString& keywords = OdString::kEmpty,
        OdSSetTracker* pTracker = 0,
        OdGePoint3dArray* ptsPointer = 0 ) override = 0;
#else
    virtual OdSelectionSetPtr select(const OdString& prompt = OdString::kEmpty,
        int options = OdEd::kSelDefault,
        const OdSelectionSet* pDefaultValue = 0,
        const OdString& keywords = OdString::kEmpty,
        OdSSetTracker* pTracker = 0) = 0;
#endif
 
    /* {secret} */
    virtual OdDbUnitsFormatter& formatter() = 0;
 
    /* {secret} */
    int getKeyword(
        const OdString& prompt,
        const OdString& keywords,
        int defVal = 0,
        int options = OdEd::kInpDefault,
        OdEdIntegerTracker* pTracker = 0) override = 0;
 
    /* {secret} */
    int getInt(
        const OdString& prompt,
        int options = OdEd::kInpDefault,
        int defVal = 0,
        const OdString& keywords = OdString::kEmpty,
        OdEdIntegerTracker* pTracker = 0) override = 0;
 
    /* {secret} */
    double getReal(
        const OdString& prompt,
        int options = OdEd::kInpDefault,
        double defVal = 0.0,
        const OdString& keywords = OdString::kEmpty,
        OdEdRealTracker* pTracker = 0) override = 0;
 
    /* {secret} */
    OdString getString(
        const OdString& prompt,
        int options = OdEd::kInpDefault,
        const OdString& defValue = OdString::kEmpty,
        const OdString& keywords = OdString::kEmpty,
        OdEdStringTracker* pTracker = 0) override = 0;
 
    /* {secret} */
    void putString(const OdString& string) override = 0;
 
    /* {secret} */
    OdString getFilePath(
        const OdString& prompt,
        int options = OdEd::kGfpForOpen,
        const OdString& dialogCaption = OdString::kEmpty,
        const OdString& defExt = OdString::kEmpty,
        const OdString& fileName = OdString::kEmpty,
        const OdString& filter = OdString::kEmpty,
        const OdString& keywords = OdString::kEmpty,
        OdEdStringTracker*  pTracker = 0) override = 0;
 
    /* {secret} */
    OdGePoint3d getLASTPOINT() const override = 0;
 
    /* {secret} */
    void setLASTPOINT(const OdGePoint3d& pt) override = 0;
 
    /* {secret} */
    void setPickfirst(OdSelectionSet* pSSet) override = 0;
    OdSelectionSetPtr pickfirst() override = 0;
    OdEdPointDefTrackerPtr createRubberBand(const OdGePoint3d& base, OdGsModel* pModel = NULL) const override = 0;
    OdEdPointDefTrackerPtr createRectFrame(const OdGePoint3d& base, OdGsModel* pModel = NULL) const override = 0;
};
 
extern DDKERNEL_API CFxUserIO* GetFxUserIO( OdEdCommandContext* pCmdCtx );
 
#include "FxPragmaPop.h"