OUTPUT_DIRECTORY = GUI
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
-USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 5
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 25
SHOW_USED_FILES = YES
-SHOW_DIRECTORIES = NO
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
-WARN_IF_UNDOCUMENTED = YES
+WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/static/footer.html
HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/static/salome_extra.css
HTML_EXTRA_FILES = @CMAKE_CURRENT_SOURCE_DIR@/images/head.png
-HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
-XML_SCHEMA =
-XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor
+# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
-PREDEFINED =
+PREDEFINED = Standard_EXPORT Handle(a):=Handle<a> DEFINE_STANDARD_RTTIEXT DEFINE_STANDARD_HANDLE IMPLEMENT_STANDARD_RTTIEXT vtkStandardNewMacro vtkTypeMacro vtkCxxSetObjectMacro vtkNotUsed(a):=a Q_ENUM _PTR(a):=_PTR<a>
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = NO
#---------------------------------------------------------------------------
-# Configuration::additions related to external references
+# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
-# Configuration options related to the dot tool
+# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
HIDE_UNDOC_RELATIONS = NO
DOT_FONTNAME = Arial
DOT_PATH =
DOTFILE_DIRS =
-MAX_DOT_GRAPH_WIDTH = 1024
-MAX_DOT_GRAPH_HEIGHT = 1200
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
-# Configuration::additions related to the search engine
+# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = YES
/*!
\brief Get all loaded modules.
- \param returning list of modules
+ \param out being returned list of modules
*/
void CAM_Application::modules( CAM_Application::ModuleList& out ) const
{
- module library can not be loaded by some reason
\param modName module name
+ \param showMsg If true, show occured errors (if any) in a warning dialog
\return module object pointer or 0 if module could not be loaded
*/
CAM_Module* CAM_Application::loadModule( const QString& modName, const bool showMsg )
\brief Check module availability.
The method can be redefined in successors. Default implementation returns \c true.
+ Input parameter is the module title
- \param title module title
\return \c true if module is accessible; \c false otherwise
*/
bool CAM_Application::checkModule( const QString& )
This virtual method can be re-implemented in the successors. Base implementation
does nothing.
- \param mod module being added
+ The inpit parameter is the module being added
*/
void CAM_Application::moduleAdded( CAM_Module* /*mod*/ )
{
}
/*!
- \brief Get module library name by its title (user name).
- \param title module name or title
+ \brief Get module library name by its name or title (user name).
+ \param name module name or title
\param full if \c true, return full library name, otherwise return its internal name
\return module library name or null QString if module is not found
*/
This method should be re-implemented in the successor classes.
Default implementation returns \c true.
- \param name study name
- \param study study
- \param files list of file names from which data should be loaded
+ The first parameter is the study name
+ The second parameter is the study
+ The third parameter is a list of file names from which data should be loaded
+
\return \c true if data model is loaded successfully
*/
bool CAM_DataModel::open( const QString& /*name*/,
This method should be re-implemented in the successor classes.
Default implementation returns \c true.
- \param files list of file names to which data should be saved
+ The input parameter is a list of file names to which data should be saved
+
\return \c true if data model is saved successfully
*/
bool CAM_DataModel::save( QStringList& )
This method should be re-implemented in the successor classes.
Default implementation returns \c true.
- \param name study name
- \param study study
- \param files resulting list of file names to which data is saved
+ The first parameter is the study name
+ The second parameter is the study
+ The third parameter is the resulting list of file names to which data is saved
+
\return \c true if data model is saved successfully
*/
bool CAM_DataModel::saveAs( const QString& /*name*/,
/*!
\brief Get data object tooltip for the specified column.
- The parameter \a id specifies the column identificator
+ The parameter specifies the column identificator
- \param id column id
\return object tooltip for the specified column
*/
QString CAM_ModuleObject::toolTip( const int /*id*/ ) const
Default implementation does nothing.
- \param oldStudy old study
- \param newStudy new study
+ The first parameter is the old study
+ The second parameter is the new study
*/
void CAM_Module::studyChanged( SUIT_Study* /*oldStudy*/, SUIT_Study* /*newStudy*/ )
{
\brief Shows the notifications with spectified text, title and automatic close timeout.
Notification will be automatically closed after specified timeout in msec. If
timeout is zero then automatic closing doesn't performed.
- \param text - Notification text
+ \param message - Notification text
\param title - Notification title
\param timeout - Notification close timeout in msec
\return notification identifier
/*!
\brief Closes the notifications with spectified text.
- \param text - Notification text
+ \param message - Notification text
*/
void CAM_Module::hideNotification( const QString& message )
{
/*!
\brief Closes the notifications with spectified identifier.
- \param text - Notification text
+ \param id - Notification identifier
*/
void CAM_Module::hideNotification( int id )
{
//================================================================================
/*! Public -
* \brief raises a CASCatch_Failure exception
- * \param an exception message
+ * \param AString an exception message
*/
//================================================================================
void CASCatch_Failure::Raise (const Standard_CString AString)
//================================================================================
/*! Public -
* \brief re-raises a CASCatch_Failure exception
- * \param an exception message
+ * \param AString an exception message
*/
//================================================================================
void CASCatch_Failure::Reraise (const Standard_CString AString)
/*!
\brief Get the names of all defined units systems.
- \param theSystemsSeq returning sequence of names
+ \param theSystemSeq returning sequence of names
*/
void DDS_DicGroup::GetUnitSystems( TColStd_SequenceOfAsciiString& theSystemSeq ) const
{
If units system is not found, empty string is returned.
- \param make units system name
+ \param name units system name
\return units system label
*/
TCollection_ExtendedString DDS_DicGroup::GetUnitSystemLabel( const TCollection_AsciiString& name ) const
/*!
Constructor
- \param type: 0 for normal line and 1 for strip line
- \param width - width of line
+ \param theType - 0 for normal line and 1 for strip line
+ \param theWidth - width of line
*/
-GLViewer_AspectLine::GLViewer_AspectLine( int type, float width )
+GLViewer_AspectLine::GLViewer_AspectLine( int theType, float theWidth )
{
myNColor = QColor( 255, 255, 255 );
myHColor = QColor( 0, 255, 255 );
mySColor = QColor( 255, 0, 0 );
- myLineWidth = width;
- if( type == 1 || type == 0 )
- myLineType = type;
+ myLineWidth = theWidth;
+ if( theType == 1 || theType == 0 )
+ myLineType = theType;
else
myLineType = 0;
}
/*!
Sets type of line
- \param type: 0 for normal line and 1 for strip line
+ \param theType: 0 for normal line and 1 for strip line
*/
-int GLViewer_AspectLine::setLineType( const int type )
+int GLViewer_AspectLine::setLineType( const int theType )
{
- if( type == 1 || type == 0 )
+ if( theType == 1 || theType == 0 )
{
- myLineType = type;
+ myLineType = theType;
return 0;
}
return 1;
/*!
\return colors of line
- \param nc - variable for normal color
- \param hc - variable for hilighting color
- \param sc - variable for selection color
+ \param theNC - variable for normal color
+ \param theHC - variable for hilighting color
+ \param theSC - variable for selection color
*/
-void GLViewer_AspectLine::getLineColors( QColor& nc, QColor& hc, QColor& sc ) const
+void GLViewer_AspectLine::getLineColors( QColor& theNC, QColor& theHC, QColor& theSC ) const
{
- nc = myNColor;
- hc = myHColor;
- sc = mySColor;
+ theNC = myNColor;
+ theHC = myHColor;
+ theSC = mySColor;
}
/*!
#endif
/*!
- \Class GLViewer_AspectLine
+ \class GLViewer_AspectLine
Substitution of Prs2d_AspectLine for OpenGL
*/
}
/*! Moves object by recomputing
- \param dx - moving along X coord
- \param dy - moving along Y coord
+ \param theX - moving along X coord
+ \param theY - moving along Y coord
\param fromGroup - is true if this method called from group
*/
void GLViewer_MarkerSet::moveObject( float theX, float theY, bool fromGroup )
/*!
Moves object by recomputing
- \param dx - moving along X coord
- \param dy - moving along Y coord
+ \param theX - moving along X coord
+ \param theY - moving along Y coord
\param fromGroup - is true if this method called from group
*/
void GLViewer_Polyline::moveObject( float theX, float theY, bool fromGroup )
/*!
Computes highlight presentation
- \param x - x coord
- \param y - y coord
- \param tol - tolerance of detecting
+ \param theX - x coord
+ \param theY - y coord
+ \param theTol - tolerance of detecting
\param isCircle - true if sensitive area of detection is round
\return true if highlight status is changed
*/
/*!
Selects text object
- /param x, y - co-ordinates of mouse
- /param tol - tolerance
- /param rect - rectangle (in case of rectangular selection)
- /param isFull - if it is true, then object may selected only if it lays whole in selection zone
+ \param theX, theY - co-ordinates of mouse
+ \param theTol - tolerance
+ \param rect - rectangle (in case of rectangular selection)
+ \param isFull - if it is true, then object may selected only if it lays whole in selection zone
\param isCircle - true if sensitive area of detection is round
\param isShift - true if selection exec with append option
*/
/*!
Moves object by recomputing
- \param dx - moving along X coord
- \param dy - moving along Y coord
+ \param theX - moving along X coord
+ \param theY - moving along Y coord
\param fromGroup - is true if this method called from group
*/
void GLViewer_TextObject::moveObject( float theX, float theY, bool fromGroup )
/*!
Hiilights objects under cursor
- \param x - X coord of mouse cursor
- \param y - Y coord of mouse cursor
+ \param xi - X coord of mouse cursor
+ \param yi - Y coord of mouse cursor
\param byCircle - true if needs round sensitive area around mouse cursor, else rectangle
function search object rectangle which intersect with sensitive area and call object highlight method
*/
\param display - true if needs display object immediatly after inserting, else false
\param isActive - true if needs inserting object in active list
*/
-int GLViewer_Context::insertObject( GLViewer_Object* object, bool display, bool isActive )
+int GLViewer_Context::insertObject( GLViewer_Object* theObject, bool display, bool isActive )
{
// cout << "GLViewer_Context::insertObject" << endl;
- if( !object )
+ if( !theObject )
return -1;
if( isActive )
{
- myActiveObjects.append( object );
+ myActiveObjects.append( theObject );
if( display )
{
- //QRect* rect = object->getRect()->toQRect();
+ //QRect* rect = theObject->getRect()->toQRect();
//myGLViewer2d->updateBorders( *rect );
- myGLViewer2d->activateDrawer( object, false );
+ myGLViewer2d->activateDrawer( theObject, false );
}
}
else
- myInactiveObjects.append( object );
+ myInactiveObjects.append( theObject );
return myActiveObjects.count() + myInactiveObjects.count();
}
//! Main interactive method. Trace mouse in viewer window
/*!
- *\param x - X coord of mouse cursor
- *\param y - Y coord of mouse cursor
- *\paran byCircle - true if needs round sensitive area around mouse cursor, else rectangle
+ *\param xi - X coord of mouse cursor
+ *\param yi - Y coord of mouse cursor
+ *\param byCircle - true if needs round sensitive area around mouse cursor, else rectangle
*function search object rectangle which intersect with sensitive area and call object highlight method
*/
- int MoveTo( int x, int y, bool byCircle = false );
+ int MoveTo( int xi, int yi, bool byCircle = false );
/*! A function selecting already highlighting object by calling object method select
*\param Append - true if new selection will be append to existing selection, false - another
*\param byCircle - true if needs round selection area in complex object
\param theFormat - text format (by default DTF_BITMAP)
*/
void GLViewer_Drawer::drawText( const QString& text, GLfloat xPos, GLfloat yPos,
- const QColor& color, QFont* theFont, int theSeparator, DisplayTextFormat theFormat )
+ const QColor& color, QFont* theFont, int theSeparator,
+ DisplayTextFormat theFormat )
{
glColor3f( ( GLfloat )color.red() / 255,
( GLfloat )color.green() / 255,
//! Draw text string
/*!
- *\param text - the text string
- *\param xPos - x coord
- *\param yPos - y coord
- *\param color - text color
- *\param aFont - base font of text
- *\param theSeparator - letter separator
- *\param DisplayTextFormat - text format
+ *\param text - the text string
+ *\param xPos - x coord
+ *\param yPos - y coord
+ *\param color - text color
+ *\param theFont - base font of text
+ *\param theSeparator - letter separator
+ *\param theFormat - text format
*/
void drawText( const QString& text,
GLfloat xPos,
- GLfloat yPos,
+ GLfloat yPos,
const QColor& color,
- QFont* aFont,
+ QFont* theFont,
int theSeparator,
- DisplayTextFormat = DTF_BITMAP );
+ DisplayTextFormat theFormat = DTF_BITMAP );
//! Draw text string
/*!
*\param smallFont - font format
*/
void drawGLText( QString text,
- float x,
- float y,
+ float x,
+ float y,
int hPosition = GLText_Center,
int vPosition = GLText_Center,
QColor color = Qt::black,
}
/*!
- constructs a ray starting at <thePnt> and directed along positive X axis direction (or Y axis if vertical )
+ constructs a ray starting at \a thePnt and directed along positive X axis direction (or Y axis if vertical )
*/
GLViewer_Segment::GLViewer_Segment( const GLViewer_Pnt& thePnt,
const GLfloat theA,
}
/*!
- detects intersection with segment <theOther>
+ detects intersection with segment \a theOther
*/
bool GLViewer_Segment::HasIntersection( const GLViewer_Segment& theOther ) const
{
}
/*!
- destructor, <myPoints> mustn't be deleted here!
+ destructor, myPoints mustn't be deleted here!
*/
GLViewer_Poly::~GLViewer_Poly()
{
}
/*!
- \return true if <thePnt> lies within this polygon
+ \return true if \a thePnt lies within this polygon
*/
bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt ) const
{
return ( aNbInter % 2 == 1 );
}
/*!
- \return true if <thePnt> lies within this polygon
+ \return true if \a thePnt lies within this polygon
*/
/*
bool GLViewer_Poly::IsIn( const GLViewer_Pnt& thePnt, const float tolerance ) const
}
*/
/*!
- \return true if <thePoly> covers this polygon
+ \return true if \a thePoly covers this polygon
*/
bool GLViewer_Poly::IsCovers( const GLViewer_Poly& thePoly ) const
{
}
/*!
- \return true if <theRect> covers this polygon
+ \return true if \a theRect covers this polygon
*/
bool GLViewer_Poly::IsCovers( const GLViewer_Rect& theRect ) const
{
\param winW and \param winH - width and height of window
\param xSize and \param ySize - steps along x and y direction
\param xPan and \param yPan - offsets along x and y direction
- \param xScale and \param yScal - scale factors along x and y direction
+ \param xScale and \param yScale - scale factors along x and y direction
*/
GLViewer_Grid::GLViewer_Grid( GLfloat /*width*/, GLfloat /*height*/,
GLfloat /*winW*/, GLfloat /*winH*/,
/*!
Dragging operation
- \param Once is true, if this operation calls only one time for all object
+ \param once is true, if this operation calls only one time for all object
\param x, y - dragging position
*/
void GLViewer_Group::dragingObjects( float x, float y, bool once )
/*!
\return line list
\param theIndex - index in list
- \param tehFD - dimension
+ \param theFD - dimension
*/
GLViewer_LineList* GLViewer_LineField::getLine( int theIndex, FieldDim theFD )
{
//! Pass rect into selector and update
void finishSelectByRect();
- //! \warnign It is for ouv
+ //! \warning It is for ouv
bool startPulling( GLViewer_Pnt );
- //! \warnign It is for ouv
+ //! \warning It is for ouv
void drawPulling( GLViewer_Pnt );
- //! \warnign It is for ouv
+ //! \warning It is for ouv
void finishPulling();
- //! \warnign It is for ouv
+ //! \warning It is for ouv
bool isPulling() const { return myIsPulling; }
//! Returns selection by rect
/*!
Compare two objects
\param anIO1 - first object to compare
- \param anIO1 - second object to compare
+ \param anIO2 - second object to compare
*/
Standard_Boolean IsEqual(const Handle(SALOME_InteractiveObject)& anIO1,
const Handle(SALOME_InteractiveObject)& anIO2)
m_sbZcoeff->setMinimumWidth( 80 );
m_sbZcoeff->setValue( 1.0 );
- // Create <Reset> button
+ // Create Reset button
m_bReset = new QPushButton( tr( "&Reset" ), aGroupBox );
// Layout widgets in the group box
QHBoxLayout* aHBoxLayout2 = new QHBoxLayout( aGroupBox2 );
aHBoxLayout2->setMargin( 11 );
aHBoxLayout2->setSpacing( 6 );
- // Create <OK> button
+ // Create OK button
QPushButton* m_bOk = new QPushButton( tr( "O&K" ), aGroupBox2 );
m_bOk->setDefault( true );
m_bOk->setAutoDefault( true );
- // Create <Apply> button
+ // Create Apply button
QPushButton* m_bApply = new QPushButton( tr( "&Apply" ), aGroupBox2 );
m_bApply->setAutoDefault( true );
- // Create <Cancel> button
+ // Create Cancel button
QPushButton* m_bCancel = new QPushButton( tr( "&Cancel" ), aGroupBox2 );
m_bCancel->setAutoDefault( true );
}
/*!
- \brief Called when <OK> button is pressed
+ \brief Called when OK button is pressed
*/
void OCCViewer_AxialScaleDlg::accept()
{
}
/*!
- \brief Called when <Apply> button is pressed
+ \brief Called when Apply button is pressed
*/
bool OCCViewer_AxialScaleDlg::apply()
{
}
/*!
- \brief Called when <Reset> button is pressed
+ \brief Called when Reset button is pressed
*/
void OCCViewer_AxialScaleDlg::reset()
{
Constructor
*/
QtxListBox::QtxListBox( QWidget* parent, const char* name, WFlags f )
-: QListBox( parent, name, f ),
+: QListWidget( parent, name, f ),
myEditor( 0 ),
myEditIndex( -1 ),
myEditState( false ),
/*!
\return current edited item
*/
-QListBoxItem* QtxListBox::editedItem() const
+QListWidgetItem* QtxListBox::editedItem() const
{
return item( editedIndex() );
}
Starts edition of item
\param item - item to be edited
*/
-void QtxListBox::startEdition( const QListBoxItem* item )
+void QtxListBox::startEdition( const QListWidgetItem* item )
{
startEdition( index( item ) );
}
Ensures that the item is visible.
\param item - item to be made visible
*/
-void QtxListBox::ensureItemVisible( const QListBoxItem* item )
+void QtxListBox::ensureItemVisible( const QListWidgetItem* item )
{
ensureItemVisible( index( item ) );
}
*/
void QtxListBox::moveItem( const int idx, const int step )
{
- QListBoxItem* i = item( idx );
+ QListWidgetItem* i = item( idx );
if ( !i || step == 0 )
return;
- QListBoxItem* cur = item( currentItem() );
+ QListWidgetItem* cur = item( currentItem() );
takeItem( i );
insertItem( i, QMAX( 0, idx + step ) );
*/
void QtxListBox::setContentsPos( int x, int y )
{
- QListBox::setContentsPos( x, y );
+ QListWidget::setContentsPos( x, y );
updateEditor();
}
}
}
- return QListBox::eventFilter( o, e );
+ return QListWidget::eventFilter( o, e );
}
/*!
else if ( e->key() == Key_Delete && e->state() & ControlButton )
deleteItem( currentItem() );
else
- QListBox::keyPressEvent( e );
+ QListWidget::keyPressEvent( e );
}
/*!
*/
void QtxListBox::viewportResizeEvent( QResizeEvent* e )
{
- QListBox::viewportResizeEvent( e );
+ QListWidget::viewportResizeEvent( e );
updateEditor();
}
if ( isEditEnabled() )
startEdition( itemAt( e->pos() ) );
else
- QListBox::mouseDoubleClickEvent( e );
+ QListWidget::mouseDoubleClickEvent( e );
}
/*!
\code
#include <QtxMsgHandler.h>
qInstallMessageHandler(QtxMsgHandler);
- \code
+ \endcode
To process Qt message implement a callback class by inheriting from
QtxMsgHandlerCallback and override its qtMessage() function.
}
/*!
- \brief Called when <Insert> button is clicked.
+ \brief Called when Insert button is clicked.
Inserts new empty line to the list and sets input focus to it.
}
/*!
- \brief Called when <Delete> button is clicked.
+ \brief Called when Delete button is clicked.
Removes currently selected path item.
}
/*!
- \brief Called when <Up> button is clicked.
+ \brief Called when Up button is clicked.
Move currently selected path item up to one row in the paths list.
}
/*!
- \brief Called when <Down> button is clicked.
+ \brief Called when Down button is clicked.
Move currently selected path item down to one row in the paths list.
}
/*!
- \brief Expand the branch specifed by the \index and all its
- children recursively.
+ \brief Expand the branch specifed by the \a index
+ and all its children recursively.
\param index model index to be expanded
\sa collapseAll()
*/
}
/*!
- \brief Collapse the branch specifed by the \index and all its
- children recursively.
+ \brief Collapse the branch specifed by the \a index
+ and all its children recursively.
\param index model index to be collapsed
\sa expandAll()
*/
/*!
\brief Process paint event.
\internal
- \param event paint event
+ The parameter is the paint event
*/
void CloseButton::paintEvent( QPaintEvent* )
{
/*!
\fn void QtxWorkstack::windowActivated( QWidget* w )
- \brief Emitted when the workstack's child widget \w is activated.
+ \brief Emitted when the workstack's child widget \a w is activated.
\param w widget being activated
*/
}
/*!
- \fn bool SalomePyQt::activateManagerAndView( const int id );
+ \fn bool SalomePyQt::activateViewManagerAndView( const int id );
\brief Activate view manager and view: useful for a view embedded in a module main Window
\param id window identifier
\return \c true if operation is completed successfully and \c false otherwise
/*!
- \fn int SalomePyQt::createView( const QString& type, bool visible = true, const int width = 0, const int height = 0 );
+ \fn int SalomePyQt::createView( const QString& type, bool visible = true, const int width = 0, const int height = 0, bool detached = false );
\brief Create new view and activate it
\param type viewer type
\param visible
}
/*!
- \fn void SalomePyQt::deleteCurve( Plot2d_Curve* theCurve )
+ \fn void SalomePyQt::eraseCurve( Plot2d_Curve* theCurve )
\brief Delete theCurve from all views
\param theCurve curve to delete
*/
ViewerTypeIdActionMap; //!< maps viewer type to IdActionMap
ViewerTypeIdActionMap myMap; //!< viewer actions map
- //! Maps key to <not_used> flag map, used for optimization.
+ //! Maps key to not_used flag map, used for optimization.
//! All registered keys (accelerators) are stored in this map.
QMap<int, bool> myOptMap;
//! Shows the application's main widget. For non GUI application must be redefined.
virtual void start();
- //! Opens document <theFileName> into active Study. If Study is empty - creates it.
+ //! Opens document \a theFileName into active Study. If Study is empty - creates it.
virtual bool useFile( const QString& theFileName);
//! Creates new empty Study if active Study = 0
}
/*!
- \brief Update object browser starting from the object \obj;
+ \brief Update object browser starting from the object \a obj;
open all branches automatically if \a autoOpen is \c true.
\param obj starting object for updating
\param autoOpen if \c true automatically open branches
/*!
\brief Get all children.
- \override
If parameter \a rec is \c true then function collects all
the children recursively.
\param defaultButton default button (QMessageBox::StandardButton)
\return button id clicked by the user (QMessageBox::StandardButton)
*/
-SUIT_MessageBox::StandardButton SUIT_MessageBox::critical( QWidget* parent, const QString& title, const QString& text,
- StandardButtons buttons, StandardButton defaultButton )
+QMessageBox::StandardButton SUIT_MessageBox::critical( QWidget* parent, const QString& title, const QString& text,
+ StandardButtons buttons, StandardButton defaultButton )
{
SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor );
return QMessageBox::critical( parent, title, text, buttons, defaultButton );
\param defaultButton default button (QMessageBox::StandardButton)
\return button id clicked by the user (QMessageBox::StandardButton)
*/
-SUIT_MessageBox::StandardButton SUIT_MessageBox::warning( QWidget* parent, const QString& title, const QString& text,
- SUIT_MessageBox::StandardButtons buttons, StandardButton defaultButton )
+QMessageBox::StandardButton SUIT_MessageBox::warning( QWidget* parent, const QString& title, const QString& text,
+ StandardButtons buttons, StandardButton defaultButton )
{
SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor );
return QMessageBox::warning( parent, title, text, buttons, defaultButton );
\param defaultButton default button (QMessageBox::StandardButton)
\return button id clicked by the user (QMessageBox::StandardButton)
*/
-SUIT_MessageBox::StandardButton SUIT_MessageBox::information( QWidget* parent, const QString& title, const QString& text,
- StandardButtons buttons, StandardButton defaultButton )
+QMessageBox::StandardButton SUIT_MessageBox::information( QWidget* parent, const QString& title, const QString& text,
+ StandardButtons buttons, StandardButton defaultButton )
{
SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor );
return QMessageBox::information( parent, title, text, buttons, defaultButton );
\param defaultButton default button (QMessageBox::StandardButton)
\return button id clicked by the user (QMessageBox::StandardButton)
*/
-SUIT_MessageBox::StandardButton SUIT_MessageBox::question( QWidget* parent, const QString& title, const QString& text,
- StandardButtons buttons, StandardButton defaultButton )
+QMessageBox::StandardButton SUIT_MessageBox::question( QWidget* parent, const QString& title, const QString& text,
+ StandardButtons buttons, StandardButton defaultButton )
{
SUIT_OverrideCursor cw( parent ? parent->cursor() : Qt::ArrowCursor );
return QMessageBox::question( parent, title, text, buttons, defaultButton );
void setButtonText( StandardButton, const QString& );
// message box with standard buttons
- static StandardButton critical( QWidget* parent, const QString& title, const QString& text,
+ static QMessageBox::StandardButton critical( QWidget* parent, const QString& title, const QString& text,
StandardButtons buttons = Ok, StandardButton defaultButton = NoButton );
- static StandardButton warning( QWidget* parent, const QString& title, const QString& text,
+ static QMessageBox::StandardButton warning( QWidget* parent, const QString& title, const QString& text,
StandardButtons buttons = Ok, StandardButton defaultButton = NoButton );
- static StandardButton information( QWidget* parent, const QString& title, const QString& text,
+ static QMessageBox::StandardButton information( QWidget* parent, const QString& title, const QString& text,
StandardButtons buttons = Ok, StandardButton defaultButton = NoButton );
- static StandardButton question( QWidget* parent, const QString& title, const QString& text,
+ static QMessageBox::StandardButton question( QWidget* parent, const QString& title, const QString& text,
StandardButtons buttons = Ok, StandardButton defaultButton = NoButton );
// message boxes with one custom button
\param first iterator pointing to the item in the list \a l from which search shoud be started
\param last iterator pointing to the item in the list \a l the search to be finished at
\param td functor class
- \return iterator pointing to the item in the list \l if the correspondence is found or iterator
- \a last if the correspondence is not found
+ \return iterator pointing to the item in the list \a l if the correspondence is found
+ or iterator \a last if the correspondence is not found
\sa synchronize()
*/
template <class SrcItem, class TrgItem, class TreeData>
QMap<QString, int> SUIT_ViewManager::_ViewMgrId;
/*!\class SUIT_ViewManager.
- * Class provide manipulation with view windows.
+ * \brief Thsi class provides manipulation with view windows.
*/
/*!Constructor.*/
#endif
/*! \class vtkAbstractPropPicker
- * \brief For more information see <a href="http://www.vtk.org/">VTK documentation
+ * \brief For more information see <a href="http://www.vtk.org/">VTK documentation</a>
*/
/*! \class SVTK_AreaPicker
* \brief Rectangular picker class.
To handle right mouse button up event (reimplemented from vtkInteractorStyle)
*/
void SVTK_InteractorStyle::OnRightButtonUp(int vtkNotUsed(ctrl),
- int shift,
+ int shift,
int vtkNotUsed(x),
int vtkNotUsed(y))
{
public:
/*! supported gradient types */
- enum {
+ enum {
HorizontalGradient,
VerticalGradient,
FirstDiagonalGradient,
/* Reimplemented from SALOME_View */
- //! See #SALOME_View::Display( const SALOME_Prs* )
+ //! See #SALOME_View::Display( const SALOME_VTKPrs* )
void Display( const SALOME_VTKPrs* );
//! See #SALOME_View::Erase( const SALOME_VTKPrs*, const bool = false )
//! See #SALOME_View::EraseAll( SALOME_Displayer*, const bool = false )
void EraseAll( SALOME_Displayer*, const bool = false );
- //! See #SALOME_View::getVisible( SALOME_ListIO& )
+ //! See #SALOME_View::GetVisible( SALOME_ListIO& )
virtual void GetVisible( SALOME_ListIO& );
//! See #SALOME_View::CreatePrs( const char* entry = 0 )
SALOME_Prs* CreatePrs( const char* entry = 0 );
- //! See #SALOME_View::isVisible( const Handle(SALOME_InteractiveObject)& )
+ //! See #SALOME_View::isVisible( const Handle<SALOME_InteractiveObject>& )
virtual bool isVisible( const Handle(SALOME_InteractiveObject)& );
//! See #SALOME_View::Repaint()
//! Redirect the request to #SVTK_Renderer::OnFitAll
virtual void onFitAll();
- //! Redirect the request to #SVTK_Renderer::OnFitSelection
+ //! Redirect the request to #SVTK_Renderer::onFitSelection
virtual void onFitSelection();
//! Redirect the request to #SVTK_Renderer::OnFitIObjects
#include <cppunit/extensions/HelperMacros.h>
/*!
- \class SalomeAppTest: test suit
+ \class SalomeAppTest
+ \brief Test suit
*/
class SalomeAppTest : public CppUnit::TestFixture
{
/*!
\brief Set visibility value of the "AttributeGraphic" attribute.
- \param theObj object
- \return theValue new visibility value
+ \param theEntry object entry
+ \param theValue new visibility value
\param theId sub-object identifier
*/
bool ToolsGUI::SetVisibility( const char* theEntry,
}
/*!
- \brief Update <OK> button's state.
+ \brief Update OK button's state.
*/
void ToolsGUI_CatalogGeneratorDlg::updateButtonState()
{
}
/*!
- \brief Called when user presses <Apply> button
+ \brief Called when user presses Apply button
Performs IDL to XML file conversion using \c runIDLparser SALOME utility.
*/
vtkActorCollection* GetActors() const;
};
- /*!For each actor(for ex: someActor) from \a theCollection(that can be dynamic cast to type TActor)\n
+ /*!For each actor(for ex: someActor) from \a theCollection(that can be dynamic cast to type TActor)
* Call method \a theFun(someActor)
*/
template<typename TActor, typename TFunction>
}
return theFun;
}
-
+
/*!Find actor from collection, that can be dynamicaly cast to \a TActor, \n
*and method \a thePredicate(someActor) return true) \n
*\retval someActor
*/
static VTKViewer_AppendFilter *New();
- /*! \fn vtkTypeMacro(VTKViewer_AppendFilter, vtkAppendFilter)
- * \brief VTK type revision macros.
- */
+ // VTK type revision macros.
vtkTypeMacro(VTKViewer_AppendFilter, vtkAppendFilter)
void SetDoMappingFlag(const bool theFlag);
* call virtual method IsValid( const int theId ).
* \param theActor - actor
* \param theCellId - cell id.
- * \retval \c true - if cell id is valid, else \c false.
+ * \retval true - if cell id is valid, else \c false.
*/
bool VTKViewer_Filter::IsValid( VTKViewer_Actor* theActor, const vtkIdType theCellId )
{
*/
static VTKViewer_GeometryFilter *New();
- /*! \fn vtkTypeMacro(VTKViewer_GeometryFilter, vtkGeometryFilter)
- * \brief VTK type revision macros.
- */
+ // VTK type revision macros.
vtkTypeMacro(VTKViewer_GeometryFilter, vtkGeometryFilter)
+
/*! \fn void SetInside(int theShowInside)
* \brief Sets \a myShowInside flag. \a myShowInside is changed, call this->Modified().
* \param theShowInside - used for changing value of \a myShowInside variable.
}
-/*!\retval \c true if needs redrawing*/
+/*!\retval true if needs redrawing*/
bool VTKViewer_InteractorStyle::needsRedrawing()
{
return State == VTK_INTERACTOR_STYLE_CAMERA_ZOOM ||
}
/*!
- \bried Get currently selected custom marker's identifier.
+ \brief Get currently selected custom marker's identifier.
For standard markers return value is VTK::MT_NONE.
*/
int VTKViewer_MarkerDlg::markerId() const
}
/*!
- \bried Get currently selected custom marker's identifier.
+ \brief Get currently selected custom marker's identifier.
For standard markers return value is VTK::MT_NONE.
*/
int VTKViewer_MarkerWidget::markerId() const
#endif
/*! Sets Arrow actor.
- * \param theLabelActor - VTKViewer_UnScaledActor
+ * \param theArrowActor - VTKViewer_UnScaledActor
*/
void SetArrowActor(vtkFollower* theArrowActor);
