ginebra2/VisibilityAnimator.h
changeset 3 0954f5dd2cd0
parent 0 1450b09d0cfd
--- a/ginebra2/VisibilityAnimator.h	Fri May 14 15:40:36 2010 +0300
+++ b/ginebra2/VisibilityAnimator.h	Tue Jun 29 00:46:29 2010 -0400
@@ -1,21 +1,24 @@
 /*
 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
 * All rights reserved.
-* This component and the accompanying materials are made available
-* under the terms of "Eclipse Public License v1.0"
-* which accompanies this distribution, and is available
-* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* This program is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Lesser General Public License as published by
+* the Free Software Foundation, version 2.1 of the License.
 *
-* Initial Contributors:
-* Nokia Corporation - initial contribution.
+* This program is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU Lesser General Public License for more details.
 *
-* Contributors:
+* You should have received a copy of the GNU Lesser General Public License
+* along with this program.  If not,
+* see "http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html/".
 *
-* Description: 
+* Description:
 *
 */
 
-
 #ifndef __GINEBRA_VISIBILITYANIMATOR_H__
 #define __GINEBRA_VISIBILITYANIMATOR_H__
 
@@ -26,9 +29,18 @@
 namespace GVA {
 class ChromeSnippet;
 
-/**
+/*!  \ingroup JavascriptAPI
  * \brief Base class for visibility animation delegates
- * 
+ *
+ * Example javascript code to set a fade animation with the default 500ms duration on a snippet.
+ * This will cause the snippet to fade-in when it is shown and fade-out when it is hidden.
+ * \code
+ * snippets.SnippetId.setVisibilityAnimator("G_VISIBILITY_FADE_ANIMATOR");
+ * \endcode
+ * Example javascript code to set a fade animation with a 200ms duration on a snippet.
+ * \code
+ * snippets.SnippetId.setVisibilityAnimator("G_VISIBILITY_FADE_ANIMATOR").duration = 200;
+ * \endcode
  * \sa ChromeSnippet::setVisibilityAnimator()
  */
 
@@ -37,11 +49,14 @@
    Q_OBJECT
 
  public:
-  VisibilityAnimator(ChromeSnippet* snippet) : m_snippet(snippet), m_timeLine(0), m_visible(true){}
+  VisibilityAnimator(ChromeSnippet* snippet) : m_snippet(snippet), m_timeLine(0), m_visible(true), m_duration(500){}
   virtual ~VisibilityAnimator();
   static VisibilityAnimator * create(const QString & name, ChromeSnippet* snippet);
   void setVisible(bool visible, bool animate = true);
   void setTimeline(QTimeLine * timeline){m_timeLine = timeline;}
+  void setDuration(uint value) { m_duration = value; }
+  uint duration() const { return m_duration; }
+  Q_PROPERTY(uint duration READ duration WRITE setDuration)
  public slots:
   virtual void updateVisibility(qreal step) = 0;
  private slots:
@@ -54,6 +69,7 @@
   ChromeSnippet* m_snippet;
   QTimeLine *m_timeLine;
   bool m_visible;
+  uint m_duration;
 };
 
 }