#include "SUIT_Study.h"
#include "SUIT_Application.h"
+/*! Constructor. Initialize myApp, myStudy, myState.*/
SUIT_Operation::SUIT_Operation( SUIT_Application* app )
: QObject(),
myApp( app ),
{
}
+/*! Destructor*/
SUIT_Operation::~SUIT_Operation()
{
}
+/*! \retval Return myStudy.*/
SUIT_Study* SUIT_Operation::study() const
{
return myStudy;
}
+/*! \retval Return myApp*/
SUIT_Application* SUIT_Operation::application() const
{
return myApp;
}
+/*! \retval Return myState*/
SUIT_Operation::OperationState SUIT_Operation::state() const
{
return myState;
}
+/*! Set started operation status*/
void SUIT_Operation::start()
{
myStudy = myApp->activeStudy();
}
}
+/*! Set aborted operation status*/
void SUIT_Operation::abort()
{
abortOperation();
emit aborted( this );
}
+/*! Set commited operation status*/
void SUIT_Operation::commit()
{
commitOperation();
myStudy->sendChangesNotification();
}
+/*! Set resumed operation status*/
void SUIT_Operation::resume()
{
resumeOperation();
emit resumed( this );
}
+/*! Set suspended operation status*/
void SUIT_Operation::suspend()
{
suspendOperation();
emit suspended( this );
}
+/*! \retval Return true*/
bool SUIT_Operation::isReadyToStart()
{
return true;
}
+/*! start operation.\n
+ * emitting callSlot() signal \n
+ * calling commit() function.
+ */
void SUIT_Operation::startOperation()
{
emit callSlot();
commit();
}
+/*! Do nothing*/
void SUIT_Operation::abortOperation()
{
}
+/*! Do nothing*/
void SUIT_Operation::resumeOperation()
{
}
+/*! Do nothing*/
void SUIT_Operation::suspendOperation()
{
}
+/*! Do nothing*/
void SUIT_Operation::commitOperation()
{
}
+/*! Setting slot.*/
bool SUIT_Operation::setSlot( const QObject* theReceiver, const char* theSlot )
{
return connect( this, SIGNAL( callSlot() ), theReceiver, theSlot );
}
+/*! \retval Return false*/
bool SUIT_Operation::isValid( SUIT_Operation* ) const
{
return false;
}
+/*! \retval Return false*/
bool SUIT_Operation::isGranted() const
{
return false;
}
+/*! Setting study.*/
void SUIT_Operation::setStudy( SUIT_Study* s )
{
myStudy = s;
}
+/*! Setting application.*/
void SUIT_Operation::setApplication( SUIT_Application* app )
{
myApp = app;
virtual void resumeOperation();
virtual void suspendOperation();
- // Returns TRUE if the given operator is valid for (can be started "above") the current operator
+ /*! Returns TRUE if the given operator is valid for (can be started "above") the current operator*/
virtual bool isValid( SUIT_Operation* ) const;
/*!
private:
SUIT_Application* myApp;
- SUIT_Study* myStudy;
+ SUIT_Study* myStudy;
OperationState myState;
friend class SUIT_Study;
#include "SUIT_OverrideCursor.h"
+/*!Constructor. Initialize wait cursor.*/
SUIT_OverrideCursor::SUIT_OverrideCursor()
{
QApplication::setOverrideCursor( QCursor( Qt::WaitCursor ) );
}
+/*!Copy constructor.*/
SUIT_OverrideCursor::SUIT_OverrideCursor( const QCursor& cursor )
{
QApplication::setOverrideCursor( cursor );
}
+/*!Destructor. restoring override cursor.*/
SUIT_OverrideCursor::~SUIT_OverrideCursor()
{
QApplication::restoreOverrideCursor();
}
+/*! Check cursors is empty */
bool SUIT_OverrideCursor::isActive() const
{
return myCursors.isEmpty();
}
+/*!Suspend cursors.*/
void SUIT_OverrideCursor::suspend()
{
if ( !isActive() )
}
}
+/*!Resume cursors.*/
void SUIT_OverrideCursor::resume()
{
if ( isActive() )
#include "SUIT.h"
+/*! \brief Class used for management cursors.*/
class SUIT_EXPORT SUIT_OverrideCursor
{
public:
#include <qtextstream.h>
-/*!
- Constructor.
-*/
+/*! Constructor. Do nothing.*/
SUIT_ParserSettings::SUIT_ParserSettings()
{
}
/*!
- Destructor.
+ Destructor. Do nothing.
*/
SUIT_ParserSettings::~SUIT_ParserSettings()
{
/*!
- Removes all HTML comments (between '<!--' and '-->').
+ Removes all HTML comments (between '<!--' and '-->') \image html html_comments.gif
*/
QString SUIT_ParserSettings::removeHtmlComments(QString s)
{
#include <qstring.h>
#include "SUIT.h"
-
+/*! \brief Text Parser.*/
class SUIT_EXPORT SUIT_ParserSettings
{
public:
#include <qevent.h>
-/*
- Class: SUIT_PopupClient [public]
- Descr: Base class for instances which creates popup menu on QContextMenuEvent
-*/
-
+/*! constructor. initialize mySignal.*/
SUIT_PopupClient::SUIT_PopupClient()
: mySignal( 0 )
{
}
+/*! destructor. delete mySignal*/
SUIT_PopupClient::~SUIT_PopupClient()
{
delete mySignal;
Descr: invoke signal which is connected to reciever in SUIT_PopupClient
*/
+/*! constructor*/
SUIT_PopupClient::Signal::Signal()
: QObject( 0 )
{
}
+/*! destructor. do nothing*/
SUIT_PopupClient::Signal::~Signal()
{}
class QPopupMenu;
class QContextMenuEvent;
-/*
- Class: SUIT_PopupClient [public]
- Descr: Base class for instances which creates popup menu on QContextMenuEvent
-*/
-
+/*!Class: SUIT_PopupClient [public] \n
+ * Descr: Base class for instances which creates popup menu on QContextMenuEvent
+ */
class SUIT_EXPORT SUIT_PopupClient
{
public:
Signal* mySignal;
};
-/*
- Class: SUIT_PopupClient::Signal [internal]
- Descr: invoke signal which is connected to reciever in SUIT_PopupClient
-*/
-
+/*! Class: SUIT_PopupClient::Signal [internal] \n
+ * Descr: invoke signal which is connected to reciever in SUIT_PopupClient
+ */
class SUIT_PopupClient::Signal : public QObject
{
Q_OBJECT
#include "SUIT_SelectionFilter.h"
+/*! constructor. do nothing*/
SUIT_SelectionFilter::SUIT_SelectionFilter()
{
}
-
+/*! destructor. do nothing*/
SUIT_SelectionFilter::~SUIT_SelectionFilter()
{
}
class SUIT_DataOwner;
+/*!Base class.*/
class SUIT_EXPORT SUIT_SelectionFilter
{
public:
#include "SUIT_SelectionMgr.h"
+/*!constructor. initialize myIterations and myIsSelChangeEnabled.*/
SUIT_SelectionMgr::SUIT_SelectionMgr( const bool Feedback )
: myIterations( Feedback ? 1 : 0 ),
myIsSelChangeEnabled( true )
{
}
+/*!destructor. mySelectors auto delete.*/
SUIT_SelectionMgr::~SUIT_SelectionMgr()
{
mySelectors.setAutoDelete( true );
SUIT_Session* SUIT_Session::mySession = 0;
+/*! Constructor.*/
+
SUIT_Session::SUIT_Session()
: QObject(),
myResMgr( 0 ),
myAppList.setAutoDelete( true );
}
+/*!destructor. Clear applications list and set mySession to zero.*/
SUIT_Session::~SUIT_Session()
{
myAppList.clear();
mySession = 0;
}
+/*! \retval return mySession */
SUIT_Session* SUIT_Session::session()
{
return mySession;
}
}
+/*! \retval return myHandler*/
SUIT_ExceptionHandler* SUIT_Session::handler() const
{
return myHandler;
}
+/*! \retval return last error string.*/
QString SUIT_Session::lastError() const
{
QString str;
return str;
}
+/*! Load library to session.
+ * \retval Loaded library.
+ */
SUIT_Session::AppLib SUIT_Session::loadLibrary( const QString& name )
{
QString libFile = SUIT_Tools::library( name );
return lib;
}
+/*! \retval Return file name by application name.*/
QString SUIT_Session::applicationName( const QString& str ) const
{
#ifdef WIN32
void SUIT_Study::createDocument()
{
- // Custom document initialization to be performed
- // within onNewDoc() handler can be put here
+ /*! Custom document initialization to be performed \n
+ * within onNewDoc() handler can be put here
+ */
}
bool SUIT_Study::openDocument( const QString& fileName )
#include "SUIT.h"
-// Purpose: to draw down arrow on toolbutton.
-
+/*! To draw down arrow on toolbutton.*/
class SUIT_EXPORT SUIT_ToolButton : public QToolButton
{
Q_OBJECT
public:
-//constructors
+ /*! @name constructors*/
+ //@{
SUIT_ToolButton( QWidget *parent = 0,
const char *name = 0,
bool changeItemAfterClick = true );
QObject * receiver, const char* slot,
QToolBar * parent, const char* name = 0,
bool changeItemAfterClick = true );
+ //@}
- //drawButton is redefined to draw DownArrow
+ /*!drawButton is redefined to draw DownArrow*/
void drawButton( QPainter * pQPainter);
- // Add action into popup
+ /*! Add action into popup*/
void AddAction(QAction* theAction);
- // Sets myPopup item with theIndex as current
+ /*! Sets myPopup item with theIndex as current*/
void SetItem(int theIndex);
public slots:
//***************************************************************
void SUIT_ViewManager::onContextMenuRequested( QContextMenuEvent* e )
{
- // invoke method of SUIT_PopupClient, which notifies about popup
+ /*! invoke method of SUIT_PopupClient, which notifies about popup*/
contextMenuRequest( e );
}
QString getTitle() const { return myTitle;}
void setTitle(QString theTitle) { myTitle = theTitle; }
- //! Creates View, adds it into list of views and returns just created view window
+ /*! Creates View, adds it into list of views and returns just created view window*/
SUIT_ViewWindow* createViewWindow();
public slots:
void onContextMenuRequested( QContextMenuEvent* e );
protected:
- /*!
- Inserts the View into internal Views Vector.
- Returns true if view has been added successfully
- */
+ /*! Inserts the View into internal Views Vector.\n
+ * Returns true if view has been added successfully
+ */
virtual bool insertView(SUIT_ViewWindow* theView);
- /*!
- Removes the View from internal Views Vector.
- */
+ /*! Removes the View from internal Views Vector.*/
virtual void removeView(SUIT_ViewWindow* theView);
- /*
- Used to set unique name for the view
- */
+ /*! Used to set unique name for the view.*/
virtual void setViewName(SUIT_ViewWindow* theView);
protected:
#include <qcursor.h>
/*!
- This object manages the definition and behaviour of a View Window.
- In case of definition of this object in an external lib that lib must
- have an exported function "createViewModel" which returns newly created
- instance of SUIT_ViewModel.
-*/
+ * This object manages the definition and behaviour of a View Window. \n
+ * In case of definition of this object in an external lib that lib must \n
+ * have an exported function "createViewModel" which returns newly created \n
+ * instance of SUIT_ViewModel.
+ */
#ifdef WIN32
#pragma warning( disable:4251 )
