Commit 08385e99 authored by Ludovic Fauvet's avatar Ludovic Fauvet
Browse files

Documentation update: GraphicsAudioItem

parent c15b8258
...@@ -37,6 +37,9 @@ class GraphicsAudioItem : public AbstractGraphicsMediaItem ...@@ -37,6 +37,9 @@ class GraphicsAudioItem : public AbstractGraphicsMediaItem
{ {
Q_OBJECT Q_OBJECT
public: public:
/**
* \brief See http://doc.trolltech.com/4.5/qgraphicsitem.html#type
*/
enum { Type = UserType + 1 }; enum { Type = UserType + 1 };
GraphicsAudioItem( Clip* clip ); GraphicsAudioItem( Clip* clip );
virtual ~GraphicsAudioItem(); virtual ~GraphicsAudioItem();
...@@ -54,7 +57,17 @@ public: ...@@ -54,7 +57,17 @@ public:
virtual Clip* clip() const; virtual Clip* clip() const;
protected: protected:
/**
* \brief Paint the item's rectangle.
* \param painter Pointer to a QPainter.
* \param option Painting options.
*/
void paintRect( QPainter* painter, const QStyleOptionGraphicsItem* option ); void paintRect( QPainter* painter, const QStyleOptionGraphicsItem* option );
/**
* \brief Paint the item's title.
* \param painter Pointer to a QPainter.
* \param option Painting options.
*/
void paintTitle( QPainter* painter, const QStyleOptionGraphicsItem* option ); void paintTitle( QPainter* painter, const QStyleOptionGraphicsItem* option );
virtual void hoverEnterEvent( QGraphicsSceneHoverEvent* event ); virtual void hoverEnterEvent( QGraphicsSceneHoverEvent* event );
virtual void hoverLeaveEvent( QGraphicsSceneHoverEvent* event ); virtual void hoverLeaveEvent( QGraphicsSceneHoverEvent* event );
...@@ -62,6 +75,9 @@ protected: ...@@ -62,6 +75,9 @@ protected:
virtual void mouseReleaseEvent( QGraphicsSceneMouseEvent* event ); virtual void mouseReleaseEvent( QGraphicsSceneMouseEvent* event );
private slots: private slots:
/**
* \deprecated Do not use.
*/
void adjustLength(); void adjustLength();
private: private:
...@@ -70,6 +86,11 @@ private: ...@@ -70,6 +86,11 @@ private:
int m_height; int m_height;
signals: signals:
/**
* \brief Emitted when the item detect a cut request.
* \param self A pointer to the sender.
* \param frame Frame's number where the cut takes place.
*/
void split( GraphicsAudioItem* self, qint64 frame ); void split( GraphicsAudioItem* self, qint64 frame );
}; };
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment