--- a/ginebra2/Snippets.h Fri May 14 15:40:36 2010 +0300
+++ b/ginebra2/Snippets.h Tue Jun 29 00:46:29 2010 -0400
@@ -1,20 +1,23 @@
/*
* 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 __gva_snippets_h__
#define __gva_snippets_h__
@@ -27,6 +30,17 @@
class ChromeSnippet;
class ChromeWidget;
+ /*! \ingroup JavascriptAPI
+ * \brief This class maintains the list of all ChromeSnippets.
+ *
+ * Javascript object name: "snippets".
+ *
+ * Example javascript code to toggle the visibility of the snippet defined ablove:
+ * \code
+ * snippets.StatusBarChromeId.toggleVisibility();
+ * \endcode
+ * \sa ChromeSnippet
+ */
class Snippets : public QObject
{
public:
@@ -34,7 +48,7 @@
virtual ~Snippets();
ChromeSnippet * getSnippet(const QString & id);
void addSnippet(ChromeSnippet *, const QString & id);
- QObjectList getList();
+ QObjectList getList();
void clear();
void dump();
private: