OpendTect  6.6
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
CmdDrive::Command Class Referenceabstract
uiCmdDriver
Inheritance diagram for CmdDrive::Command:
[legend]

Public Types

enum  FormTag {
  NoForm =0 , Text , Number , Colour ,
  Value , Angle , Minimum , Maximum ,
  Step , Percentage , FilePath
}
 

Public Member Functions

 Command (CmdDriver &cmddrv)
 
virtual ~Command ()
 
virtual bool act (const char *parstr)=0
 
virtual bool isLocalEnvCommand () const
 
virtual bool isOpenQDlgCommand () const
 
virtual bool isUiObjChangeCommand () const
 
virtual bool isVisualCommand () const
 
virtual const char * name () const =0
 

Static Public Member Functions

static BufferString factoryKey (const char *name)
 
static void initStandardCommands ()
 
static bool isQuestionName (const char *, CmdDriver &)
 

Protected Member Functions

uiMainWin * applWin ()
 
int curActionIdx () const
 
const uiMainWin * curWin () const
 
bool didInterceptSucceed (const char *objnm)
 
bool doLocalAction (uiObject *localenv, const char *actstr)
 
void end ()
 
ExprInterpreter & exprInterpreter ()
 
void finishActivate ()
 
bool goingToChangeUiObj () const
 
bool greyOutsSkipped () const
 
IdentifierManager & identifierMan ()
 
bool insertProcedure (int defidx)
 
void interact (const InteractSpec *)
 
const MenuInfo & interceptedMenuInfo () const
 
bool isCaseSensitive () const
 
void jump (int extralines=0)
 
int lastActionIdxMove () const
 
const uiObject * localSearchEnv () const
 
CmdDriver::OnErrorTag onError () const
 
bool openQDlg () const
 
const char * outputDir () const
 
bool prepareActivate (Activator *)
 
void prepareIntercept (const FileMultiString &menupath, int onoff, CmdDriver::InterceptMode=CmdDriver::Click)
 
void setCaseSensitive (bool yn)
 
void setOnError (CmdDriver::OnErrorTag)
 
void setRecoveryStep (CmdDriver::RecoveryTag)
 
void setSleep (float time, bool regular)
 
void setWait (float time, bool regular)
 
void skipGreyOuts (bool yn=true)
 
bool switchCurWin (uiMainWin *)
 
bool tryAction (const char *identname, const char *actstr)
 
bool verifyWinAssert (const char *newwinstr=0)
 
bool verifyWinState (const char *newwinstr=0, WinStateType newwinstate=NoState)
 
void waitForClearance ()
 
WildcardManager & wildcardMan ()
 

Static Protected Member Functions

static BufferString createFactoryKey (const char *keyword)
 

Protected Attributes

CmdDriver & drv_
 

Detailed Description

<>

Member Enumeration Documentation

◆ FormTag

enum CmdDrive::Command::FormTag
Enumerator
NoForm 
Text 
Number 
Colour 
Value 
Angle 
Minimum 
Maximum 
Step 
Percentage 
FilePath 

Constructor & Destructor Documentation

◆ Command()

CmdDrive::Command::Command ( CmdDriver &  cmddrv)
inline

◆ ~Command()

virtual CmdDrive::Command::~Command ( )
inlinevirtual

Member Function Documentation

◆ act()

virtual bool CmdDrive::Command::act ( const char *  parstr)
pure virtual

Implemented in CmdDrive::GetTreeMenuItemCmd, CmdDrive::IsTreeMenuItemOnCmd, CmdDrive::NrTreeMenuItemsCmd, CmdDrive::GetTreePathCmd, CmdDrive::GetTreeItemCmd, CmdDrive::GetTreeColCmd, CmdDrive::CurTreeItemCmd, CmdDrive::CurTreeColCmd, CmdDrive::CurTreePathCmd, CmdDrive::IsTreeButtonOnCmd, CmdDrive::IsTreeItemExpandedCmd, CmdDrive::IsTreeItemOnCmd, CmdDrive::NrTreeColsCmd, CmdDrive::NrTreeItemsCmd, CmdDrive::TreeExpandCmd, CmdDrive::TreeButtonCmd, CmdDrive::TreeMenuCmd, CmdDrive::TreeClickCmd, CmdDrive::GetTableMenuItemCmd, CmdDrive::IsTableMenuItemOnCmd, CmdDrive::NrTableMenuItemsCmd, CmdDrive::GetTableItemCmd, CmdDrive::GetTableColCmd, CmdDrive::GetTableRowCmd, CmdDrive::CurTableItemCmd, CmdDrive::CurTableColCmd, CmdDrive::CurTableRowCmd, CmdDrive::IsTableItemOnCmd, CmdDrive::NrTableColsCmd, CmdDrive::NrTableRowsCmd, CmdDrive::TableMenuCmd, CmdDrive::TableExecCmd, CmdDrive::TableSelectCmd, CmdDrive::TableFillCmd, CmdDrive::TableClickCmd, CmdDrive::SnapshotCmd, CmdDrive::FileOkCmd, CmdDrive::ColorOkCmd, CmdDrive::IsShownCmd, CmdDrive::GetTabCmd, CmdDrive::IsTabOnCmd, CmdDrive::CurTabCmd, CmdDrive::NrTabsCmd, CmdDrive::GetButtonMenuItemCmd, CmdDrive::IsButtonMenuItemOnCmd, CmdDrive::NrButtonMenuItemsCmd, CmdDrive::GetButtonCmd, CmdDrive::IsButtonOnCmd, CmdDrive::GetMenuItemCmd, CmdDrive::IsMenuItemOnCmd, CmdDrive::NrMenuItemsCmd, CmdDrive::OkCancelCmd, CmdDrive::ButtonMenuCmd, CmdDrive::TabCmd, CmdDrive::ShowCmd, CmdDrive::CloseCmd, CmdDrive::ButtonCmd, CmdDrive::MenuCmd, CmdDrive::GetListMenuItemCmd, CmdDrive::IsListMenuItemOnCmd, CmdDrive::NrListMenuItemsCmd, CmdDrive::GetListItemCmd, CmdDrive::CurListItemCmd, CmdDrive::IsListButtonOnCmd, CmdDrive::IsListItemOnCmd, CmdDrive::NrListItemsCmd, CmdDrive::IsComboItemOnCmd, CmdDrive::NrComboItemsCmd, CmdDrive::CurComboItemCmd, CmdDrive::GetComboItemCmd, CmdDrive::ListSelectCmd, CmdDrive::ListMenuCmd, CmdDrive::ListClickCmd, CmdDrive::ListButtonCmd, CmdDrive::ComboCmd, CmdDrive::GetSliderCmd, CmdDrive::GetSpinCmd, CmdDrive::GetInputCmd, CmdDrive::SliderCmd, CmdDrive::SpinCmd, CmdDrive::InputCmd, CmdDrive::EndCmd, CmdDrive::CallCmd, CmdDrive::ReturnCmd, CmdDrive::FedCmd, CmdDrive::DefCmd, CmdDrive::ContinueCmd, CmdDrive::BreakCmd, CmdDrive::RofCmd, CmdDrive::ForCmd, CmdDrive::OdCmd, CmdDrive::DoWhileCmd, CmdDrive::OdUntilCmd, CmdDrive::DoCmd, CmdDrive::FiCmd, CmdDrive::ElseCmd, CmdDrive::ElseIfCmd, CmdDrive::IfCmd, CmdDrive::WindowCmd, CmdDrive::GuideCmd, CmdDrive::PauseCmd, CmdDrive::WinAssertCmd, CmdDrive::WaitCmd, CmdDrive::TryCmd, CmdDrive::SleepCmd, CmdDrive::OnOffCheckCmd, CmdDrive::OnErrorCmd, CmdDrive::LogModeCmd, CmdDrive::IsWindowCmd, CmdDrive::IsMatchCmd, CmdDrive::GreyOutsCmd, CmdDrive::CommentCmd, CmdDrive::CaseCmd, CmdDrive::AssignCmd, CmdDrive::GetCanvasMenuItemCmd, CmdDrive::IsCanvasMenuItemOnCmd, CmdDrive::NrCanvasMenuItemsCmd, and CmdDrive::CanvasMenuCmd.

◆ applWin()

uiMainWin* CmdDrive::Command::applWin ( )
protected

◆ createFactoryKey()

static BufferString CmdDrive::Command::createFactoryKey ( const char *  keyword)
staticprotected

◆ curActionIdx()

int CmdDrive::Command::curActionIdx ( ) const
protected

◆ curWin()

const uiMainWin* CmdDrive::Command::curWin ( ) const
protected

◆ didInterceptSucceed()

bool CmdDrive::Command::didInterceptSucceed ( const char *  objnm)
protected

◆ doLocalAction()

bool CmdDrive::Command::doLocalAction ( uiObject *  localenv,
const char *  actstr 
)
protected

◆ end()

void CmdDrive::Command::end ( )
protected

◆ exprInterpreter()

ExprInterpreter& CmdDrive::Command::exprInterpreter ( )
protected

◆ factoryKey()

static BufferString CmdDrive::Command::factoryKey ( const char *  name)
static

◆ finishActivate()

void CmdDrive::Command::finishActivate ( )
protected

◆ goingToChangeUiObj()

bool CmdDrive::Command::goingToChangeUiObj ( ) const
protected

◆ greyOutsSkipped()

bool CmdDrive::Command::greyOutsSkipped ( ) const
protected

◆ identifierMan()

IdentifierManager& CmdDrive::Command::identifierMan ( )
protected

◆ initStandardCommands()

static void CmdDrive::Command::initStandardCommands ( )
static

◆ insertProcedure()

bool CmdDrive::Command::insertProcedure ( int  defidx)
protected

◆ interact()

void CmdDrive::Command::interact ( const InteractSpec *  )
protected

◆ interceptedMenuInfo()

const MenuInfo& CmdDrive::Command::interceptedMenuInfo ( ) const
protected

◆ isCaseSensitive()

bool CmdDrive::Command::isCaseSensitive ( ) const
protected

◆ isLocalEnvCommand()

virtual bool CmdDrive::Command::isLocalEnvCommand ( ) const
inlinevirtual

Reimplemented in CmdDrive::IsShownCmd, CmdDrive::GetMenuItemCmd, CmdDrive::IsMenuItemOnCmd, CmdDrive::NrMenuItemsCmd, CmdDrive::MenuCmd, CmdDrive::UiObjQuestionCmd, and CmdDrive::UiObjectCmd.

◆ isOpenQDlgCommand()

virtual bool CmdDrive::Command::isOpenQDlgCommand ( ) const
inlinevirtual

Reimplemented in CmdDrive::GetButtonCmd, CmdDrive::IsButtonOnCmd, CmdDrive::ShowCmd, CmdDrive::ButtonCmd, CmdDrive::WindowCmd, CmdDrive::GuideCmd, CmdDrive::PauseCmd, CmdDrive::UiObjQuestionCmd, and CmdDrive::UiObjectCmd.

◆ isQuestionName()

static bool CmdDrive::Command::isQuestionName ( const char *  ,
CmdDriver &   
)
static

◆ isUiObjChangeCommand()

virtual bool CmdDrive::Command::isUiObjChangeCommand ( ) const
inlinevirtual

Reimplemented in CmdDrive::TreeQuestionCmd, CmdDrive::TableQuestionCmd, and CmdDrive::UiObjectCmd.

◆ isVisualCommand()

virtual bool CmdDrive::Command::isVisualCommand ( ) const
inlinevirtual

Reimplemented in CmdDrive::TreeQuestionCmd, CmdDrive::TableQuestionCmd, CmdDrive::StealthCmd, and CmdDrive::UiObjQuestionCmd.

◆ jump()

void CmdDrive::Command::jump ( int  extralines = 0)
protected

◆ lastActionIdxMove()

int CmdDrive::Command::lastActionIdxMove ( ) const
protected

◆ localSearchEnv()

const uiObject* CmdDrive::Command::localSearchEnv ( ) const
protected

◆ name()

virtual const char* CmdDrive::Command::name ( ) const
pure virtual

Implemented in CmdDrive::GetTreeMenuItemCmd, CmdDrive::IsTreeMenuItemOnCmd, CmdDrive::NrTreeMenuItemsCmd, CmdDrive::GetTreePathCmd, CmdDrive::GetTreeItemCmd, CmdDrive::GetTreeColCmd, CmdDrive::CurTreeItemCmd, CmdDrive::CurTreeColCmd, CmdDrive::CurTreePathCmd, CmdDrive::IsTreeButtonOnCmd, CmdDrive::IsTreeItemExpandedCmd, CmdDrive::IsTreeItemOnCmd, CmdDrive::NrTreeColsCmd, CmdDrive::NrTreeItemsCmd, CmdDrive::TreeQuestionCmd, CmdDrive::TreeExpandCmd, CmdDrive::TreeButtonCmd, CmdDrive::TreeMenuCmd, CmdDrive::TreeClickCmd, CmdDrive::TreeCmd, CmdDrive::GetTableMenuItemCmd, CmdDrive::IsTableMenuItemOnCmd, CmdDrive::NrTableMenuItemsCmd, CmdDrive::GetTableItemCmd, CmdDrive::GetTableColCmd, CmdDrive::GetTableRowCmd, CmdDrive::CurTableItemCmd, CmdDrive::CurTableColCmd, CmdDrive::CurTableRowCmd, CmdDrive::IsTableItemOnCmd, CmdDrive::NrTableColsCmd, CmdDrive::NrTableRowsCmd, CmdDrive::TableMenuCmd, CmdDrive::TableExecCmd, CmdDrive::TableQuestionCmd, CmdDrive::TableSelectCmd, CmdDrive::TableFillCmd, CmdDrive::TableClickCmd, CmdDrive::TableCmd, CmdDrive::SnapshotCmd, CmdDrive::FileOkCmd, CmdDrive::ColorOkCmd, CmdDrive::IsShownCmd, CmdDrive::GetTabCmd, CmdDrive::IsTabOnCmd, CmdDrive::CurTabCmd, CmdDrive::NrTabsCmd, CmdDrive::GetButtonMenuItemCmd, CmdDrive::IsButtonMenuItemOnCmd, CmdDrive::NrButtonMenuItemsCmd, CmdDrive::GetButtonCmd, CmdDrive::IsButtonOnCmd, CmdDrive::GetMenuItemCmd, CmdDrive::IsMenuItemOnCmd, CmdDrive::NrMenuItemsCmd, CmdDrive::CancelCmd, CmdDrive::OkCmd, CmdDrive::OkCancelCmd, CmdDrive::ButtonMenuCmd, CmdDrive::TabCmd, CmdDrive::ShowCmd, CmdDrive::CloseCmd, CmdDrive::ButtonCmd, CmdDrive::MenuCmd, CmdDrive::GetListMenuItemCmd, CmdDrive::IsListMenuItemOnCmd, CmdDrive::NrListMenuItemsCmd, CmdDrive::GetListItemCmd, CmdDrive::CurListItemCmd, CmdDrive::IsListButtonOnCmd, CmdDrive::IsListItemOnCmd, CmdDrive::NrListItemsCmd, CmdDrive::IsComboItemOnCmd, CmdDrive::NrComboItemsCmd, CmdDrive::CurComboItemCmd, CmdDrive::GetComboItemCmd, CmdDrive::ListSelectCmd, CmdDrive::ListMenuCmd, CmdDrive::ListClickCmd, CmdDrive::ListButtonCmd, CmdDrive::ComboCmd, CmdDrive::GetSliderCmd, CmdDrive::GetSpinCmd, CmdDrive::GetInputCmd, CmdDrive::SliderCmd, CmdDrive::SpinCmd, CmdDrive::InputCmd, CmdDrive::EndCmd, CmdDrive::CallCmd, CmdDrive::ReturnCmd, CmdDrive::FedCmd, CmdDrive::DefCmd, CmdDrive::ContinueCmd, CmdDrive::BreakCmd, CmdDrive::RofCmd, CmdDrive::ForCmd, CmdDrive::OdCmd, CmdDrive::DoWhileCmd, CmdDrive::OdUntilCmd, CmdDrive::DoCmd, CmdDrive::FiCmd, CmdDrive::ElseCmd, CmdDrive::ElseIfCmd, CmdDrive::IfCmd, CmdDrive::WindowCmd, CmdDrive::GuideCmd, CmdDrive::PauseCmd, CmdDrive::WinAssertCmd, CmdDrive::WaitCmd, CmdDrive::TryCmd, CmdDrive::SleepCmd, CmdDrive::OnOffCheckCmd, CmdDrive::OnErrorCmd, CmdDrive::LogModeCmd, CmdDrive::IsWindowCmd, CmdDrive::IsMatchCmd, CmdDrive::GreyOutsCmd, CmdDrive::CommentCmd, CmdDrive::CaseCmd, CmdDrive::AssignCmd, CmdDrive::StealthCmd, CmdDrive::UiObjQuestionCmd, CmdDrive::UiObjectCmd, CmdDrive::GetCanvasMenuItemCmd, CmdDrive::IsCanvasMenuItemOnCmd, CmdDrive::NrCanvasMenuItemsCmd, and CmdDrive::CanvasMenuCmd.

◆ onError()

CmdDriver::OnErrorTag CmdDrive::Command::onError ( ) const
protected

◆ openQDlg()

bool CmdDrive::Command::openQDlg ( ) const
protected

◆ outputDir()

const char* CmdDrive::Command::outputDir ( ) const
protected

◆ prepareActivate()

bool CmdDrive::Command::prepareActivate ( Activator *  )
protected

◆ prepareIntercept()

void CmdDrive::Command::prepareIntercept ( const FileMultiString &  menupath,
int  onoff,
CmdDriver::InterceptMode  = CmdDriver::Click 
)
protected

◆ setCaseSensitive()

void CmdDrive::Command::setCaseSensitive ( bool  yn)
protected

◆ setOnError()

void CmdDrive::Command::setOnError ( CmdDriver::OnErrorTag  )
protected

◆ setRecoveryStep()

void CmdDrive::Command::setRecoveryStep ( CmdDriver::RecoveryTag  )
protected

◆ setSleep()

void CmdDrive::Command::setSleep ( float  time,
bool  regular 
)
protected

◆ setWait()

void CmdDrive::Command::setWait ( float  time,
bool  regular 
)
protected

◆ skipGreyOuts()

void CmdDrive::Command::skipGreyOuts ( bool  yn = true)
protected

◆ switchCurWin()

bool CmdDrive::Command::switchCurWin ( uiMainWin *  )
protected

◆ tryAction()

bool CmdDrive::Command::tryAction ( const char *  identname,
const char *  actstr 
)
protected

◆ verifyWinAssert()

bool CmdDrive::Command::verifyWinAssert ( const char *  newwinstr = 0)
protected

◆ verifyWinState()

bool CmdDrive::Command::verifyWinState ( const char *  newwinstr = 0,
WinStateType  newwinstate = NoState 
)
protected

◆ waitForClearance()

void CmdDrive::Command::waitForClearance ( )
protected

◆ wildcardMan()

WildcardManager& CmdDrive::Command::wildcardMan ( )
protected

Member Data Documentation

◆ drv_

CmdDriver& CmdDrive::Command::drv_
protected

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2022