FRX SDK Documentation 2025 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
AcPlPlotProgressDialog Class Referenceabstract

#include <AcPlPlotProgress.h>

Inheritance diagram for AcPlPlotProgressDialog:
AcPlPlotProgress

Public Types

enum  PlotMSGIndex {
  kDialogTitle , kSheetName , kSheetNameToolTip , kStatus ,
  kSheetProgressCaption , kSheetSetProgressCaption , kMsgCancelling , kMsgCancellingCurrent ,
  kCancelSheetBtnMsg , kCancelJobBtnMsg , kMsgCount
}
 
- Public Types inherited from AcPlPlotProgress
enum  PlotCancelStatus { kPlotContinue , kPlotCanceledByCaller , kPlotCanceledByCancelAllButton , kPlotCancelStatusCount }
 
enum  SheetCancelStatus {
  kSheetContinue , kSheetCanceledByCancelButton , kSheetCanceledByCancelAllButton , kSheetCanceledByCaller ,
  kSheetCancelStatusCount
}
 

Public Member Functions

virtual bool onBeginPlot ()=0
 
virtual bool onEndPlot ()=0
 
virtual bool onBeginSheet ()=0
 
virtual bool onEndSheet ()=0
 
virtual bool setPlotMsgString (PlotMSGIndex index, const ACHAR *pMsg)=0
 
virtual bool getPlotMsgString (PlotMSGIndex index, ACHAR *&pMsg) const =0
 
virtual bool isSingleSheetPlot () const =0
 
virtual void destroy ()=0
 
- Public Member Functions inherited from AcPlPlotProgress
virtual bool isPlotCancelled () const =0
 
virtual void setPlotCancelStatus (PlotCancelStatus Cancel)=0
 
virtual PlotCancelStatus plotCancelStatus () const =0
 
virtual void setPlotProgressRange (int nLower, int nUpper)=0
 
virtual void getPlotProgressRange (int &nLower, int &nUpper) const =0
 
virtual void setPlotProgressPos (int nPos)=0
 
virtual int plotProgressPos () const =0
 
virtual bool isSheetCancelled () const =0
 
virtual void setSheetCancelStatus (SheetCancelStatus Cancel)=0
 
virtual SheetCancelStatus sheetCancelStatus () const =0
 
virtual void setSheetProgressRange (int nLower, int nUpper)=0
 
virtual void getSheetProgressRange (int &nLower, int &nUpper) const =0
 
virtual void setSheetProgressPos (int nPos)=0
 
virtual int sheetProgressPos () const =0
 
virtual bool setIsVisible (bool bVisible)=0
 
virtual bool isVisible () const =0
 
virtual bool setStatusMsgString (const ACHAR *pMsg)=0
 
virtual bool getStatusMsgString (ACHAR *&pMsg) const =0
 
virtual void heartbeat (void)=0
 

Detailed Description

Definition at line 66 of file _impl_include/acad/AcPlPlotProgress.h.

Member Enumeration Documentation

◆ PlotMSGIndex

Enumerator
kDialogTitle 
kSheetName 
kSheetNameToolTip 
kStatus 
kSheetProgressCaption 
kSheetSetProgressCaption 
kMsgCancelling 
kMsgCancellingCurrent 
kCancelSheetBtnMsg 
kCancelJobBtnMsg 
kMsgCount 

Definition at line 69 of file _impl_include/acad/AcPlPlotProgress.h.

Member Function Documentation

◆ destroy()

virtual void AcPlPlotProgressDialog::destroy ( )
pure virtual

◆ getPlotMsgString()

virtual bool AcPlPlotProgressDialog::getPlotMsgString ( PlotMSGIndex index,
ACHAR *& pMsg ) const
pure virtual

◆ isSingleSheetPlot()

virtual bool AcPlPlotProgressDialog::isSingleSheetPlot ( ) const
pure virtual

◆ onBeginPlot()

virtual bool AcPlPlotProgressDialog::onBeginPlot ( )
pure virtual

◆ onBeginSheet()

virtual bool AcPlPlotProgressDialog::onBeginSheet ( )
pure virtual

◆ onEndPlot()

virtual bool AcPlPlotProgressDialog::onEndPlot ( )
pure virtual

◆ onEndSheet()

virtual bool AcPlPlotProgressDialog::onEndSheet ( )
pure virtual

◆ setPlotMsgString()

virtual bool AcPlPlotProgressDialog::setPlotMsgString ( PlotMSGIndex index,
const ACHAR * pMsg )
pure virtual

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