CFxUserIO Class Reference

#include <FxUserIO.h>

Inheritance diagram for CFxUserIO:

Classes
struct	CFxRange

Public Types
enum	_SelectMode {   eNormal = 1 , ePickFirst , eCrossing , eObjectClassification ,   eCrossingPolygon , eFence , eLast , ePrevious ,   eWindow , eWindowPolygon , eFilter , eBox ,   eGroup , eByPoint , eLasso , eSingleMode = 0x100 ,   eSubobjects = 0x200 , eEverythingInAperture = 0x400 }
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 }
enum	_KeywordsEx {   eKwAdd = 0x1000 , eKwRemove = 0x2000 , eKwMultiple = 0x4000 , eKwPrevious = 0x8000 ,   eKwUndo = 0x10000 , eKwAUto = 0x20000 , eKwSIngle = 0x40000 , eKwSUbobject = 0x80000 ,   eKwObject = 0x100000 , eKwSSGet }
enum	_FileNameFlags { eFileNameNoFlags = 0 , eFileNameHaveMenu = 1 }
enum	_FileNameType {   eTypeFilter = 0x000000FF , eNew = 0x00000001 , eOpen = 0x00000002 , eSave = 0x00000004 ,   eOpenFilter = 0x0000FF00 , eOpenNoPreview = 0x00000100 , eOpenNoReadOnly = 0x00000200 , eOpenNoTemplateHandling = 0x00000400 ,   eOpenNotExist = 0x00000800 }
enum	_FileNameRetVal {   eFileNew = 0x000001 , eFileNewNoTemplateImperial = 0x000002 , eFileNewNoTemplateMetric = 0x000003 , eFileOpen = 0x000100 ,   eFileOpenReadOnly = 0x000300 , eFileSave = 0x010000 }
typedef enum CFxUserIO::_SelectMode	SelectMode
typedef enum CFxUserIO::_Keywords	Keywords
typedef enum CFxUserIO::_KeywordsEx	KeywordsEx
typedef enum CFxUserIO::_FileNameFlags	FileNameFlags
typedef enum CFxUserIO::_FileNameType	FileNameType
typedef enum CFxUserIO::_FileNameRetVal	FileNameRetVal
typedef std::vector< CFxUserIO::FileNameRetVal >	FileNameRetValArray

Public Member Functions
	CFxUserIO ()
	~CFxUserIO () override
virtual void	Write (const CFxString &prompt)
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
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
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, 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, 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 OdDbObjectIdArray &	GetPreviousSelectionSet () const =0
virtual void	SetPreviousSelectionSet (const OdDbObjectIdArray &ids)=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
Public Member Functions inherited from OdStaticRxObject< OdDbUserIO >
void	addRef ()
void	release ()
Public Member Functions inherited from OdDbUserIO
	ODRX_DECLARE_MEMBERS (OdDbUserIO)
virtual void	setPickfirst (OdSelectionSet *pSSet)=0
virtual OdSelectionSetPtr	pickfirst ()=0
virtual OdCmColor	getColor (const OdString &prompt, int options=OdEd::kInpDefault, const OdCmColor *pDefaultValue=0, const OdString &keywords=OdString::kEmpty, OdEdColorTracker *pTracker=0)=0
virtual 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=NULL)=0
Public Member Functions inherited from OdEdBaseUserIO
	ODRX_DECLARE_MEMBERS (OdEdBaseUserIO)
virtual OdGePoint3d	getLASTPOINT () const =0
virtual void	setLASTPOINT (const OdGePoint3d &pt)=0
virtual OdEdPointDefTrackerPtr	createRubberBand (const OdGePoint3d &base, OdGsModel *pModel=NULL) const =0
virtual OdEdPointDefTrackerPtr	createRectFrame (const OdGePoint3d &base, OdGsModel *pModel=NULL) const =0
virtual OdGePoint3d	getPoint (const OdString &prompt, int options=OdEd::kGptDefault, const OdGePoint3d *pDefaultValue=0, const OdString &keywords=OdString::kEmpty, OdEdPointTracker *pTracker=0)=0
virtual double	getAngle (const OdString &prompt, int options=OdEd::kInpDefault, double defaultValue=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0)=0
virtual double	getDist (const OdString &prompt, int options=OdEd::kInpDefault, double defaultValue=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0)=0
Public Member Functions inherited from OdEdUserIO
	ODRX_DECLARE_MEMBERS (OdEdUserIO)
virtual bool	interactive ()
virtual int	getKeyword (const OdString &prompt, const OdString &keywords, int defVal=-1, int options=OdEd::kInpDefault, OdEdIntegerTracker *pTracker=0)=0
virtual int	getInt (const OdString &prompt, int options=OdEd::kInpDefault, int defVal=0, const OdString &keywords=OdString::kEmpty, OdEdIntegerTracker *pTracker=0)=0
virtual double	getReal (const OdString &prompt, int options=OdEd::kInpDefault, double defVal=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0)=0
virtual OdString	getString (const OdString &prompt, int options=OdEd::kInpDefault, const OdString &defValue=OdString::kEmpty, const OdString &keywords=OdString::kEmpty, OdEdStringTracker *pTracker=0)=0
virtual void	putString (const OdString &string)=0
virtual OdSharedPtr< OdCmColorBase >	getCmColor (const OdString &prompt, int options=OdEd::kInpDefault, const OdCmColorBase *pDefaultValue=0, const OdString &keywords=OdString::kEmpty, OdEdColorTracker *pTracker=0)=0
virtual 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)
virtual void	putError (const OdString &errmsg)
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
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, 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, CFxString *templateName=0, FileNameFlags flags=eFileNameNoFlags, OdCodePageId **pCodepage=0)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Member Functions
OdGePoint3d	getPoint (const OdString &prompt, int options=OdEd::kGptDefault, const OdGePoint3d *pDefaultValue=0, const OdString &keywords=OdString::kEmpty, OdEdPointTracker *pTracker=0) override=0
double	getAngle (const OdString &prompt, int options=OdEd::kInpDefault, double defaultValue=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0) override=0
double	getDist (const OdString &prompt, int options=OdEd::kInpDefault, double defaultValue=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0) override=0
OdCmColor	getColor (const OdString &prompt, int options=OdEd::kInpDefault, const OdCmColor *pDefaultValue=0, const OdString &keywords=OdString::kEmpty, OdEdColorTracker *pTracker=0) override=0
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
virtual OdDbUnitsFormatter &	formatter ()=0
int	getKeyword (const OdString &prompt, const OdString &keywords, int defVal=0, int options=OdEd::kInpDefault, OdEdIntegerTracker *pTracker=0) override=0
int	getInt (const OdString &prompt, int options=OdEd::kInpDefault, int defVal=0, const OdString &keywords=OdString::kEmpty, OdEdIntegerTracker *pTracker=0) override=0
double	getReal (const OdString &prompt, int options=OdEd::kInpDefault, double defVal=0.0, const OdString &keywords=OdString::kEmpty, OdEdRealTracker *pTracker=0) override=0
OdString	getString (const OdString &prompt, int options=OdEd::kInpDefault, const OdString &defValue=OdString::kEmpty, const OdString &keywords=OdString::kEmpty, OdEdStringTracker *pTracker=0) override=0
void	putString (const OdString &string) override=0
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
OdGePoint3d	getLASTPOINT () const override=0
void	setLASTPOINT (const OdGePoint3d &pt) override=0
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

Friends
class	CFxCommandParser

Detailed Description

Description: Represents the user input and output. Library: DDKERNEL

Definition at line 138 of file FxUserIO.h.

Member Typedef Documentation

FileNameFlags

typedef enum CFxUserIO::_FileNameFlags CFxUserIO::FileNameFlags

Description:

FileNameRetVal

typedef enum CFxUserIO::_FileNameRetVal CFxUserIO::FileNameRetVal

Description:

FileNameRetValArray

typedef std::vector<CFxUserIO::FileNameRetVal> CFxUserIO::FileNameRetValArray

Definition at line 684 of file FxUserIO.h.

FileNameType

typedef enum CFxUserIO::_FileNameType CFxUserIO::FileNameType

Description:

Keywords

typedef enum CFxUserIO::_Keywords CFxUserIO::Keywords

Description:

KeywordsEx

typedef enum CFxUserIO::_KeywordsEx CFxUserIO::KeywordsEx

Description:

SelectMode

typedef enum CFxUserIO::_SelectMode CFxUserIO::SelectMode

Description: Interactive modes only. This enum doesn't contain non-interactive modes like entire database or last.

Member Enumeration Documentation

_FileNameFlags

enum CFxUserIO::_FileNameFlags

Description:

Enumerator
eFileNameNoFlags
eFileNameHaveMenu

Definition at line 647 of file FxUserIO.h.

_FileNameRetVal

enum CFxUserIO::_FileNameRetVal

Description:

Enumerator
eFileNew
eFileNewNoTemplateImperial
eFileNewNoTemplateMetric
eFileOpen
eFileOpenReadOnly
eFileSave

Definition at line 672 of file FxUserIO.h.

_FileNameType

enum CFxUserIO::_FileNameType

Description:

Enumerator
eTypeFilter
eNew
eOpen
eSave
eOpenFilter
eOpenNoPreview
eOpenNoReadOnly
eOpenNoTemplateHandling
eOpenNotExist

Definition at line 655 of file FxUserIO.h.

_Keywords

enum CFxUserIO::_Keywords

Description:

Enumerator
eKwNone
eKwWindow
eKwLast
eKwCrossing
eKwALL
eKwBOX
eKwFence
eKwWPolygon
eKwCPolygon
eKwGroup
eKwEntSel
eKwNEntSel

Definition at line 184 of file FxUserIO.h.

_KeywordsEx

enum CFxUserIO::_KeywordsEx

Description:

Enumerator
eKwAdd
eKwRemove
eKwMultiple
eKwPrevious
eKwUndo
eKwAUto
eKwSIngle
eKwSUbobject
eKwObject
eKwSSGet

Definition at line 203 of file FxUserIO.h.

_SelectMode

enum CFxUserIO::_SelectMode

Description: Interactive modes only. This enum doesn't contain non-interactive modes like entire database or last.

Enumerator
eNormal
ePickFirst
eCrossing
eObjectClassification
eCrossingPolygon
eFence
eLast
ePrevious
eWindow
eWindowPolygon
eFilter
eBox
eGroup
eByPoint
eLasso
eSingleMode
eSubobjects
eEverythingInAperture

Definition at line 159 of file FxUserIO.h.

Constructor & Destructor Documentation

CFxUserIO()

CFxUserIO::CFxUserIO

(

)

~CFxUserIO()

CFxUserIO::~CFxUserIO ( )

override

Member Function Documentation

createRectFrame()

OdEdPointDefTrackerPtr CFxUserIO::createRectFrame ( const OdGePoint3d &  base, OdGsModel *  pModel = NULL  ) const

overrideprotectedpure virtual

Implements OdEdBaseUserIO.

createRubberBand()

OdEdPointDefTrackerPtr CFxUserIO::createRubberBand ( const OdGePoint3d &  base, OdGsModel *  pModel = NULL  ) const

overrideprotectedpure virtual

Implements OdEdBaseUserIO.

DoEntsel()

virtual int CFxUserIO::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  )

pure virtual

Description: Prompts for the user to pick one entity. Arguments:

Parameters

sPrompt	Input
pSelectionSet	Input
pFilter	Input
pickPointWCS	Input
bPointInput	Input
keywords	Input
flags	Input
pTrackers	Input Return Value:

DoNentsel()

virtual int CFxUserIO::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  )

pure virtual

Description: Returns the attribute's Entity Name. Arguments:

Parameters

sPrompt	Input
pSelectionSet	Input
pFilter	Input
pickPointWCS	Input
pickflag	Input
modelToWorld	Input
containerBlocks	Output The array of ids ordered from highest to lowest. In other words, the first id in the array is the id of the block that was directly inserted into the drawing, and the last id of the array is the id of the block that contains the selected entity. If the selected entity is not a nested entity, array is empty.
keywords	Input
flags	Input
pTrackers	Input Return Value:

DoSSGet()

virtual int CFxUserIO::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  )

pure virtual

Description: Prompts the user to select entities. Arguments:

Parameters

eMode	Input
pSelectionSet	Input
keywords	Input
sSelectPrompt	Input
sRemovePrompt	Input
pFilter	Input
pickPointsWCS	Input
bSingleMode	Input
flags	Input
pTrackers	Input Return Value:

formatter()

virtual OdDbUnitsFormatter & CFxUserIO::formatter ( )

protectedpure virtual

GetActiveGlobalKeywords()

virtual const CFxStringArray & CFxUserIO::GetActiveGlobalKeywords ( CFxStringArray &  activeGlobalAbbreviations ) const

pure virtual

Description: Returns global keywords for active input operation. Arguments:

Parameters

activeGlobalAbbreviations

output The array of Global Abbreviations Return Value:

GetActiveLocalKeywords()

virtual const CFxStringArray & CFxUserIO::GetActiveLocalKeywords ( CFxStringArray &  activeLocalAbbreviations ) const

pure virtual

Description: Returns local keywords for active input operation. Arguments:

Parameters

activeLocalAbbreviations

output The array of Local Abbreviations Return Value:

GetActivePrompt()

virtual const CFxString & CFxUserIO::GetActivePrompt ( ) const

pure virtual

Description: Returns prompt for active input operation.

Prompt is formatted for display and includes keywords and default value Return Value:

GetAngle()

virtual int CFxUserIO::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  )

pure virtual

Description: Returns angle input. Arguments:

Parameters

prompt	Input
pDefaultValue	Input
pBasePointWCS	Input
pResult	Input
pRange	Input
pTracker	Input
errorPrompt	Input
bDoNotShowBasePointLine	Input
pTrackers	Input
pPlane	Input Return Value:

getAngle()

double CFxUserIO::getAngle ( const OdString &  prompt, int  options = OdEd::kInpDefault, double  defaultValue = 0.0, const OdString &  keywords = OdString::kEmpty, OdEdRealTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of an angle.

Parameters

prompt	[in] Message displayed to prompt the user.
options	[in] Combination of OdEd::GetPointOptions enum values.
defaultValue	[in] Default value to return if an empty string is received as input.
keywords	[in] Keyword string.
pTracker	[in] Pointer to a User IO tracker.

Remarks

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

If prompt is an empty string, a default prompt string is used.

Remarks

All angles are expressed in radians.

Implements OdEdBaseUserIO.

getColor()

OdCmColor CFxUserIO::getColor ( const OdString &  prompt, int  options = OdEd::kInpDefault, const OdCmColor *  pDefaultValue = 0, const OdString &  keywords = OdString::kEmpty, OdEdColorTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of a color.

Parameters

prompt	[in] Message displayed to prompt the user.
options	[in] Combination of OdEd::GetPointOptions enum values.
pDefaultValue	[in] Pointer to a default value to return if an empty string is received as input.
keywords	[in] Keyword string.
pTracker	[in] Pointer to a User IO tracker.

Remarks

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

If prompt is an empty string, a default prompt string is used.

Implements OdDbUserIO.

GetCorner()

virtual int CFxUserIO::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  )

pure virtual

Description: Returns corner input. Arguments:

Parameters

prompt	Input
pDefaultValue	Input
pBasePtWCS	Input
pResult	Input
pRange	Input
pTracker	Input
errorPrompt	Input
pTrackers	Input
pPlane	Input Return Value:

GetDirection()

virtual int CFxUserIO::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  )

pure virtual

Description: Arguments:

Parameters

prompt	Input
pDefaultValue	Input
pBasePointWCS	Input
pResult	Input
pRange	Input
pTracker	Input
errorPrompt	Input
bDoNotShowBasePointLine	Input
pTrackers	Input
pPlane	Input Return Value:

GetDist()

virtual int CFxUserIO::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  )

pure virtual

Description: Returns distance input. Arguments:

Parameters

prompt	Input
pDefaultValue	Input
pBasePtWCS	Input
pResult	Input
pRange	Input
pTracker	Input
errorPrompt	Input
bDoNotShowBasePointLine	Input
pTrackers	Input
pPlane	Input Return Value:

getDist()

double CFxUserIO::getDist ( const OdString &  prompt, int  options = OdEd::kInpDefault, double  defaultValue = 0.0, const OdString &  keywords = OdString::kEmpty, OdEdRealTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of a distance.

Parameters

prompt	[in] Message displayed to prompt the user.
options	[in] Combination of OdEd::GetPointOptions enum values.
defaultValue	[in] Default value to return if an empty string is received as input.
keywords	[in] Keyword string.
pTracker	[in] Pointer to a User IO tracker.

Remarks

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

If prompt is an empty string, a default prompt string is used.

Implements OdEdBaseUserIO.

GetDouble()

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

pure virtual

Description: Returns double input. Arguments:

Parameters

sPrompt	Input
pDefaultVal	Input
pResult	Input
pRange	Input
pTracker	Input
errorPrompt	Input
pTrackers	Input Return Value:

GetFileName()

virtual int CFxUserIO::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, CFxString *  templateName = 0, FileNameFlags  flags = eFileNameNoFlags, OdCodePageId **  codepage = 0  )

pure virtual

Description: We use a reference to bFILEDIA so that we can alert the caller if the filedia=0 has been overriden with ~ input. Arguments:

Parameters

bFILEDIA	Input
prompt	Input
defaultFileName	Input
pResultMode	Input
pResultStr	Input
parent	Input
eType	Input
defaultExtension	Input
filter	Input
initialDir	Input
filterIndex	Input
templateName	Input
flags	Input
pCodepage	Input Return Value:

GetFileNames()

virtual int CFxUserIO::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, CFxString *  templateName = 0, FileNameFlags  flags = eFileNameNoFlags, OdCodePageId **  codepage = 0  )

pure virtual

Description: Arguments:

Parameters

bFILEDIA	Input
prompt	Input
defaultFileName	Input
pResultMode	Input
pResultStrs	Input
parent	Input
eType	Input
defaultExtension	Input
filter	Input
initialDir	Input
filterIndex	Input
templateName	Input
flags	Input
pCodepage	Input Return Value:

GetFileNamesStatic_Obsolete()

static int CFxUserIO::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, CFxString *  templateName = 0, FileNameFlags  flags = eFileNameNoFlags, OdCodePageId **  pCodepage = 0  )

static

Description: Arguments:

Parameters

pResultMode	Input
pResultStrs	Input
parent	Input
eType	Input
dialogCaption	Input
defaultExtension	Input
filter	Input
initialDir	Input
filterIndex	Input
templateName	Input
flags	Input
pCodepage	Input Return Value:

GetFileNameStatic_Obsolete()

static int CFxUserIO::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, CFxString *  templateName = 0, FileNameFlags  flags = eFileNameNoFlags, OdCodePageId **  pCodepage = 0  )

static

Description: Arguments:

Parameters

pResultMode	Input
pResultStr	Input
parent	Input
eType	Input
dialogCaption	Input
defaultExtension	Input
filter	Input
initialDir	Input
filterIndex	Input
templateName	Input
flags	Input
pCodepage	Input Return Value:

getFilePath()

OdString CFxUserIO::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  )

overrideprotectedpure virtual

Returns user input of a filename obtained in some manner.

Parameters

options	[in] combination of OdEd::CommonInputOptions and OdEd::GetFilePathFlags enum values.
prompt	[in] Prompt output before pausing for user input.
dialogCaption	[in] Dialog caption.
defExt	[in] Default file extension without "."
fileName	[in] Initial filename to initialize dialog with.
filter	[in] Filter pattern.
pTracker	[in/out] File path tracker; may be used to display file preview.

Remarks

flags must be one of the following:

Value Description OdEd::kGfpForOpen 0 For Open. OdEd::kGfpForSave 1 For Save. OdEd::kGfpOverwritePrompt 2 Enable overwrite prompt displaying when exist file selected for saving.

The default implementation of this function utilizes getString().

Reimplemented from OdEdUserIO.

GetFxCurrentSelectionSet()

virtual CFxSelectionSet * CFxUserIO::GetFxCurrentSelectionSet ( )

pure virtual

Description: Returns main selection set being called outside of DoEntSel or DoSSGet Returns active selection set being called inside of DoEntSel or DoSSGet Return Value:

GetInt()

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

pure virtual

Description: Returns integer input. Arguments:

Parameters

prompt	Input
pDefaultVal	Input
pResult	Input
pRange	Input
pTracker	Input
errorPrompt	Input
pTrackers	Input Return Value:

getInt()

int CFxUserIO::getInt ( const OdString &  prompt, int  options = OdEd::kInpDefault, int  defVal = 0, const OdString &  keywords = OdString::kEmpty, OdEdIntegerTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of an integer.

Parameters

prompt	[in] Prompt output before pausing for user input.
pTracker	[in/out] Pointer to an IO Tracker for this user input.
options	[in] Bitwise OR combination of OdEd::CommonInputOptions enum.
defVal	[in] Returned if user input nothing and OdEd::kInpReturnDefVal flag is set.

Remarks

If prompt is empty, a default prompt is used.

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

Implements OdEdUserIO.

GetKeyword()

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

pure virtual

Description: Returns keyword input. Arguments:

Parameters

sPrompt	Input
sDefault	Input
pResult	Input
pTracker	Input
pTrackers	Input Return Value:

getKeyword()

int CFxUserIO::getKeyword ( const OdString &  prompt, const OdString &  keywords, int  defVal = 0, int  options = OdEd::kInpDefault, OdEdIntegerTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of a keyword.

Parameters

prompt	[in] Prompt output before pausing for user input.
keywords	[in] Keyword list.
options	[in] Bitwise OR combination of OdEd::CommonInputOptions enum.
defVal	[in] Returned if user input nothing.

Returns

Returns the index of the entered keyword in the keyword list, or -1 it's not there.

Remarks

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

This function does not throw a KeywordException.

Implements OdEdUserIO.

getLASTPOINT()

OdGePoint3d CFxUserIO::getLASTPOINT ( ) const

overrideprotectedpure virtual

Implements OdEdBaseUserIO.

GetNoteEditor() [1/2]

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

pure virtual

Description: opens in Place editor. Interface is similar to GetNoteEditor(OdDbEntityPtr& EntType,int nFlag, ...) Interface using CONFIGURABLE(8)-flag, but in addition offers option to provide an appropriate configuration.

Arguments:

Parameters

EntType	Input OdDbMTextPtr of the Text-Entity to be edited.
config	Input configuration of the NoteEditor with customisable UI. s.a. CFxNoteEditorConfig
iHelpID	Input identifier of Help-Topic only required considered if help Button is configured.
errorPrompt	Input message to provide to the user in case of an error.
pTrackers	Input tracker to be considered during user input.
pPlane	Input Plane to draw the Editor onto. If not given the default is using working plane of active document.
bPinToOldLocation	Input if true Toolbar stay at its former position, On false(default) the toolbar will be positioned base on the Editor position

Return Value:

GetNoteEditor() [2/2]

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

pure virtual

Description: opens in Place editor using preconfigured Editors. Arguments:

Parameters

EntType	Input either OdDbMTextPtr or an OdDbText (only for flag SIMPLENOTE(0), and CONSTRAINTS(7) )
nFlag	Input int to identify preconfigured Editors. possible values: SIMPLENOTE 0 NOTE 1 DIMTEXT 2 TABLETEXT 3 ATTDEFTEXT 4 LEADERTEXT 5 SIMPLENOTERECUR 6 CONSTRAINTS 7 CONFIGURABLE 8

For an editor having customisable UI use CONFIGURABLE(8). This Interface will provide a DefaultConfig only. Use GetNoteEditor( OdDbEntityPtr & EntType, CFxNoteEditorConfigPtr config, ...) instead to provide an appropriate configuration.

Parameters

iHelpID	Input identifier of Help-Topic only considered in TABLETEXT(3)-Editors and ATTDEFTEXT(4).
errorPrompt	Input message to provide to the user in case of an error.
pTrackers	Input tracker to be considered during user input.
pPlane	Input Plane to draw the Editor onto. If not given the default is using working plane of active document.
bPinToOldLocation	Input if true Toolbar stay at its former position, On false(default) the toolbar will be positioned base on the Editor position

Return Value:

GetOrient()

virtual int CFxUserIO::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  )

pure virtual

Description: Returns orientation input. Arguments:

Parameters

prompt	Input
pDefaultValue	Input
pBasePtWCS	Input
pResult	Input
pRange	Input
pTracker	Input
errorPrompt	Input
bDoNotShowBasePointLine	Input
pTrackers	Input
pPlane	Input Return Value:

GetPoint()

virtual int CFxUserIO::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  )

pure virtual

Description: Returns point input. Arguments:

Parameters

sPrompt	Input
pDefaultValue	Input
pBasePointWCS	Input
pReturnValueWCS	Input
pTracker	Input
errorPrompt	Input
bDoNotShowBasePointLine	Input
pTrackers	Input
pPlane	Input Return Value:

getPoint()

OdGePoint3d CFxUserIO::getPoint ( const OdString &  prompt, int  options = OdEd::kGptDefault, const OdGePoint3d *  pDefaultValue = 0, const OdString &  keywords = OdString::kEmpty, OdEdPointTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of a point.

Parameters

prompt	[in] Message displayed to prompt the user.
options	[in] Combination of OdEd::GetPointOptions enum values.
pDefaultValue	[in] Pointer to a default value to return if an empty string is received as input.
keywords	[in] Keyword string.
pTracker	[in] Pointer to a User IO tracker.

Remarks

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

If prompt is an empty string, a default prompt string is used.

Implements OdEdBaseUserIO.

GetPreviousSelectionSet()

virtual const OdDbObjectIdArray & CFxUserIO::GetPreviousSelectionSet ( ) const

pure virtual

Description: Returns previous selection sets ids Possibly refactor to OdDbStubPtrArray or remove from this API completely Return Value:

GetPrompt() [1/2]

virtual CFxString CFxUserIO::GetPrompt ( const CFxString &  prompt ) const

pure virtual

Description: Arguments:

Parameters

prompt

Input Return Value:

GetPrompt() [2/2]

virtual CFxString CFxUserIO::GetPrompt ( const CFxString &  prompt, const CFxString &  range  ) const

pure virtual

Description: Arguments:

Parameters

prompt	Input
range	Input Return Value:

GetPromptAngle()

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

pure virtual

Description: Reads angle prompt Arguments:

Parameters

prompt	Input
pDefaultValue	Input
ignoreANGBASE	Input Return Value:

GetPromptDist()

virtual CFxString CFxUserIO::GetPromptDist ( const CFxString &  prompt, const double *  pDefaultValue  ) const

pure virtual

Description: Reads distance prompt. Arguments:

Parameters

prompt	Input
pDefaultValue	Input Return Value:

GetPromptInt() [1/2]

virtual CFxString CFxUserIO::GetPromptInt ( const CFxString &  prompt, const int *  pDefaultValue  ) const

pure virtual

Description: Reads type integer prompt Arguments:

Parameters

prompt	Input
pDefaultValue	Input Return Value:

GetPromptInt() [2/2]

virtual CFxString CFxUserIO::GetPromptInt ( const CFxString &  prompt, const int *  pDefaultValue, const CFxString &  range  ) const

pure virtual

Description: Arguments:

Parameters

prompt	Input
pDefaultValue	Input
range	Input Return Value:

GetPromptKeyword() [1/2]

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

pure virtual

Description: Arguments:

Parameters

prompt	Input
pDefaultValue	Input Return Value:

GetPromptKeyword() [2/2]

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

pure virtual

Description: Reads type only keyword prompt Arguments:

Parameters

pDefaultValue	Input
pOptionDescription	Input Return Value:

GetPromptPoint() [1/2]

virtual CFxString CFxUserIO::GetPromptPoint ( const CFxString &  prompt, const OdGePoint2d *  pDefaultValue  ) const

pure virtual

Description: Reads Point2d prompt Arguments:

Parameters

prompt	Input
pDefaultValue	Input Return Value:

GetPromptPoint() [2/2]

virtual CFxString CFxUserIO::GetPromptPoint ( const CFxString &  prompt, const OdGePoint3d *  pDefaultValue  ) const

pure virtual

Description: Reads Point3d prompt Arguments:

Parameters

prompt	Input
pDefaultValue	Input Return Value:

GetPromptReal()

virtual CFxString CFxUserIO::GetPromptReal ( const CFxString &  prompt, const double *  pDefaultValue  ) const

pure virtual

Description: Reads type real prompt Arguments:

Parameters

prompt	Input
pDefaultValue	Input Return Value:

GetPromptString() [1/2]

virtual CFxString CFxUserIO::GetPromptString ( const CFxString &  prompt, const CFxString *  pDefaultValue  ) const

pure virtual

Description: Reads string prompt Arguments:

Parameters

prompt	Input
pDefaultValue	Input Return Value:

GetPromptString() [2/2]

virtual CFxString CFxUserIO::GetPromptString ( const CFxString &  prompt, const CFxString *  pDefaultValue, const CFxString &  range  ) const

pure virtual

Description: Arguments:

Parameters

prompt	Input
pDefaultValue	Input
range	Input Return Value:

getReal()

double CFxUserIO::getReal ( const OdString &  prompt, int  options = OdEd::kInpDefault, double  defVal = 0.0, const OdString &  keywords = OdString::kEmpty, OdEdRealTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of a double.

Parameters

prompt	[in] Prompt output before pausing for user input.
options	[in] Bitwise OR combination of OdEd::CommonInputOptions enum.
defVal	[in] Returned if user input nothing and OdEd::kInpReturnDefVal flag is set.
pTracker	[in] Pointer to an IO Tracker for this user input.

Remarks

If prompt is empty, a default prompt is used.

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

Implements OdEdUserIO.

GetString()

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

pure virtual

Description: Returns string input. Arguments:

Parameters

bIgnoreSpaces	Input
sPrompt	Input
sDefaultVal	Input
pResult	Input
pTracker	Input
pTrackers	Input Return Value:

getString()

OdString CFxUserIO::getString ( const OdString &  prompt, int  options = OdEd::kInpDefault, const OdString &  defValue = OdString::kEmpty, const OdString &  keywords = OdString::kEmpty, OdEdStringTracker *  pTracker = 0  )

overrideprotectedpure virtual

Returns user input of a string.

Parameters

options	[in] combination of OdEd::CommonInputOptions and OdEd::GetStringOptions enum values.
prompt	[in] Prompt output before pausing for user input.
pTracker	[in] Pointer to an IO Tracker for this user input.
defValue	[in] Default value.
keywords	[in] Keyword string.

Remarks

If prompt is empty, a default prompt is used.

This function uses the underlying OdEdBaseIO functions putString and getString for low level output and input.

Implements OdEdUserIO.

GetUnitsFormatter()

virtual const CFxUnitsFormatter * CFxUserIO::GetUnitsFormatter ( ) const

pure virtual

Description: Returns units formatter. Return Value:

GetUserInput() [1/2]

virtual const CFxString & CFxUserIO::GetUserInput ( ) const

pure virtual

Description: Returns user input. Return Value:

GetUserInput() [2/2]

virtual int CFxUserIO::GetUserInput ( CFxString *  pInput )

pure virtual

Description: Gets and store user input. Arguments:

Parameters

pInput

Input Return Value:

GetZoomScale()

virtual int CFxUserIO::GetZoomScale ( double *  pScale, const CFxString &  userInput, const CFxView *  pView  ) const

pure virtual

Description: Defines zoom scale input Arguments:

Parameters

pScale	Input
userInput	Input
pView	Input Return Value:

Initget() [1/3]

virtual void CFxUserIO::Initget ( int  iFlags )

pure virtual

Description: Arguments:

Parameters

iFlags

Input

Initget() [2/3]

virtual void CFxUserIO::Initget ( int  iFlags, const CFxKeywordArray &  keywords  )

pure virtual

Description: Arguments:

Parameters

iFlags	Input
keywords	Input

Initget() [3/3]

virtual void CFxUserIO::Initget ( int  iFlags, const CFxStringArray &  keywordsGlobal, const CFxStringArray &  keywordsLocal  )

pure virtual

Description: Arguments:

Parameters

iFlags	Input
keywordsGlobal	Input
keywordsLocal	Input

InitgetFlags()

virtual int CFxUserIO::InitgetFlags ( ) const

pure virtual

Description: Returns active initget flags. Return Value:

IsPending()

virtual bool CFxUserIO::IsPending ( ) const

pure virtual

Description: Returns state of input Return Value:

MessageBox()

virtual int CFxUserIO::MessageBox ( bool  bFILEDIA, const CFxString &  prompt, const CFxString &  caption, unsigned int  uType  )

pure virtual

Description: Arguments:

Parameters

bFILEDIA	Input
prompt	Input
caption	Input
uType	Input Return Value:

MessageLoop_Obsolete()

virtual void CFxUserIO::MessageLoop_Obsolete ( bool  bClickAllowed, bool  bIgnoreWhiteSpaces, CFxTracker *  pInputTracker, OdResBufPtr &  pInput, TRACKER_VECTOR *  pTrackers  )

pure virtual

Description: Function which waits for a string input Arguments:

Parameters

bClickAllowed	Input
bIgnoreWhiteSpaces	Input
pInputTracker	Input
pInput	Input
pTrackers	Input

pickfirst()

OdSelectionSetPtr CFxUserIO::pickfirst ( )

overrideprotectedpure virtual

Implements OdDbUserIO.

putString()

void CFxUserIO::putString ( const OdString &  string )

overrideprotectedpure virtual

Writes the specified string to the command's output.

Parameters

string

[in] string to write.

Implements OdEdUserIO.

select()

virtual OdSelectionSetPtr CFxUserIO::select ( const OdString &  prompt = OdString::kEmpty, int  options = OdEd::kSelDefault, const OdSelectionSet *  pDefaultValue = 0, const OdString &  keywords = OdString::kEmpty, OdSSetTracker *  pTracker = 0  )

protectedpure virtual

SetCurrentPrompt()

virtual void CFxUserIO::SetCurrentPrompt ( const CFxString &  prompt, bool  bWrite = false  )

pure virtual

Description: Sets prompt for active input operation Arguments:

Parameters

prompt	Input
bWriteToOutput	Input Return Value:

SetIsPrintSelectResults()

virtual void CFxUserIO::SetIsPrintSelectResults ( bool  value )

pure virtual

Description: Suppress printing selection results. Flag resets after call of a GetXXX function(like initget flags). Arguments:

Parameters

value

Input

setLASTPOINT()

void CFxUserIO::setLASTPOINT ( const OdGePoint3d &  pt )

overrideprotectedpure virtual

Implements OdEdBaseUserIO.

setPickfirst()

void CFxUserIO::setPickfirst ( OdSelectionSet *  pSSet )

overrideprotectedpure virtual

Implements OdDbUserIO.

SetPreviousSelectionSet()

virtual void CFxUserIO::SetPreviousSelectionSet ( const OdDbObjectIdArray &  ids )

pure virtual

Description: Sets previous selection sets ids Arguments:

Parameters

ids

Input

SetPromptExplanation()

virtual void CFxUserIO::SetPromptExplanation ( const CFxString &  explanation )

pure virtual

Description: Reads general prompt. Arguments:

Parameters

explanation

Input

Write()

virtual void CFxUserIO::Write ( const CFxString &  prompt )

virtual

Description: Writes line with given string. Arguments:

Parameters

prompt

Input

Friends And Related Function Documentation

CFxCommandParser

friend class CFxCommandParser

friend

Definition at line 140 of file FxUserIO.h.

---

The documentation for this class was generated from the following file:

• FxUserIO.h