Ajout de documentation

git-svn-id: svn+ssh://svn.tuxfamily.org/svnroot/qet/qet/trunk@225 bfdf4180-ca20-0410-9c96-a3a8aa849046
This commit is contained in:
xavierqet
2007-12-09 10:07:33 +00:00
parent 09ed881f0d
commit b4b61ad6f0
3 changed files with 52 additions and 1 deletions

View File

@@ -66,6 +66,7 @@ class PartPolygon : public QGraphicsPolygonItem, public CustomElementGraphicPart
protected:
QVariant itemChange(GraphicsItemChange, const QVariant &);
};
/**
Specifie si le polygone doit etre ferme
@param c true pour un polygone ferme, false sinon

View File

@@ -119,11 +119,17 @@ class QETElementEditor : public QMainWindow {
void xmlPreview();
};
/**
@param siz La nouvelle taille de l'element edite
*/
inline void QETElementEditor::setSize(const QSize &siz) {
ce_scene -> setWidth(siz.width());
ce_scene -> setHeight(siz.height());
}
/**
@return la taille de l'element edite
*/
inline QSize QETElementEditor::size() const {
return(
QSize(
@@ -133,35 +139,59 @@ inline QSize QETElementEditor::size() const {
);
}
/**
@param hs Le nouveau point de saisie de l'element edite
*/
inline void QETElementEditor::setHotspot(const QPoint &hs) {
ce_scene -> setHotspot(hs);
}
/**
@return le point de saisie de l'element edite
*/
inline QPoint QETElementEditor::hotspot() const {
return(ce_scene -> hotspot());
}
/**
@param nameslist le nouvel ensemble de noms de l'element edite
*/
inline void QETElementEditor::setNames(const NamesList &nameslist) {
ce_scene -> setNames(nameslist);
}
/**
@param orientation_set le nouvel ensemble d'orientations de l'element edite
*/
inline void QETElementEditor::setOrientations(const OrientationSet &orientation_set) {
ce_scene -> setOrientations(orientation_set);
}
/**
@return le nouvel ensemble d'orientations de l'element edite
*/
inline OrientationSet QETElementEditor::orientations() const {
return(ce_scene -> orientations());
}
/**
@param fn Le nouveau nom de fichier de l'element edite
*/
inline void QETElementEditor::setFileName(const QString &fn) {
_filename = fn;
slot_updateTitle();
}
/**
@return le nomde fichier de l'element edite
*/
inline QString QETElementEditor::fileName() const {
return(_filename);
}
/**
@return la scene d'edition de l'element
*/
inline ElementScene *QETElementEditor::elementScene() const {
return(ce_scene);
}

View File

@@ -73,31 +73,51 @@ class OrientationSet {
QString toString() const;
};
/**
@return true si l'orientation "Nord" est autorisee, false sinon
*/
inline bool OrientationSet::north() const {
return(north_ori);
}
/**
@return true si l'orientation "Est" est autorisee, false sinon
*/
inline bool OrientationSet::east() const {
return(east_ori);
}
/**
@return true si l'orientation "Sud" est autorisee, false sinon
*/
inline bool OrientationSet::south() const {
return(south_ori);
}
/**
@return true si l'orientation "Ouest" est autorisee, false sinon
*/
inline bool OrientationSet::west() const {
return(west_ori);
}
/**
@param theValue La nouvelle orientation par defaut
*/
inline void OrientationSet::setDefaultOrientation(const QET::Orientation& theValue) {
default_ori = theValue;
}
/**
@return L'orientation par defaut
*/
inline QET::Orientation OrientationSet::defaultOrientation() const {
return(default_ori);
}
/**
@return L'orientation actuelle
*/
inline QET::Orientation OrientationSet::current() const {
return(current_ori);
}