summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo Parente Lima <hugo.pl@gmail.com>2011-03-01 20:30:30 -0300
committerHugo Parente Lima <hugo.pl@gmail.com>2011-03-01 20:32:10 -0300
commit8ac29700ce8419ea6a4f6b70186cd9dfea208ba8 (patch)
tree4686be2a8976b99d6dd1efffd8eb341568b0f57b
parentee92e460f12a0a723ea150c8f7625a7acd1b2af2 (diff)
downloadpyside-8ac29700ce8419ea6a4f6b70186cd9dfea208ba8.tar.gz
pyside-8ac29700ce8419ea6a4f6b70186cd9dfea208ba8.tar.xz
pyside-8ac29700ce8419ea6a4f6b70186cd9dfea208ba8.zip
Added module documentation for all modules.
-rw-r--r--doc/extras/PySide.QtCore.rst5
-rw-r--r--doc/extras/PySide.QtDeclarative.rst5
-rw-r--r--doc/extras/PySide.QtGui.rst7
-rw-r--r--doc/extras/PySide.QtHelp.rst24
-rw-r--r--doc/extras/PySide.QtMultimedia.rst7
-rw-r--r--doc/extras/PySide.QtNetwork.rst5
-rw-r--r--doc/extras/PySide.QtOpenGL.rst14
-rw-r--r--doc/extras/PySide.QtScript.rst21
-rw-r--r--doc/extras/PySide.QtScriptTools.rst5
-rw-r--r--doc/extras/PySide.QtSql.rst5
-rw-r--r--doc/extras/PySide.QtSvg.rst16
-rw-r--r--doc/extras/PySide.QtWebKit.rst94
-rw-r--r--doc/extras/PySide.QtXml.rst5
-rw-r--r--doc/extras/PySide.QtXmlPatterns.rst35
-rw-r--r--doc/extras/PySide.phonon.rst34
15 files changed, 282 insertions, 0 deletions
diff --git a/doc/extras/PySide.QtCore.rst b/doc/extras/PySide.QtCore.rst
new file mode 100644
index 0000000..f9e05d2
--- /dev/null
+++ b/doc/extras/PySide.QtCore.rst
@@ -0,0 +1,5 @@
+All other Qt modules rely on this module. To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtCore
diff --git a/doc/extras/PySide.QtDeclarative.rst b/doc/extras/PySide.QtDeclarative.rst
new file mode 100644
index 0000000..4b94adc
--- /dev/null
+++ b/doc/extras/PySide.QtDeclarative.rst
@@ -0,0 +1,5 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtDeclarative
diff --git a/doc/extras/PySide.QtGui.rst b/doc/extras/PySide.QtGui.rst
new file mode 100644
index 0000000..f575c2f
--- /dev/null
+++ b/doc/extras/PySide.QtGui.rst
@@ -0,0 +1,7 @@
+To include the definitions of modules classes, use the following directive:
+
+::
+
+ import PySide.QtGui
+
+.. seealso:: :mod:`PySide.QtCore`
diff --git a/doc/extras/PySide.QtHelp.rst b/doc/extras/PySide.QtHelp.rst
new file mode 100644
index 0000000..9fa7442
--- /dev/null
+++ b/doc/extras/PySide.QtHelp.rst
@@ -0,0 +1,24 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtHelp
+
+License Information
+-------------------
+
+The QtHelp module uses the CLucene indexing library to provide full-text searching capabilities for Qt Assistant and applications that use the features of QtHelp.
+
+Qt Commercial Edition licensees that wish to distribute applications that use these features of the QtHelp module need to be aware of their obligations under the GNU Lesser General Public License (LGPL).
+
+Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL; version 2.1 for applications and libraries licensed under the GNU GPL version 2, or version 3 for applications and libraries licensed under the GNU GPL version 3.
+
+Copyright (C) 2003-2006 Ben van Klinken and the CLucene Team
+
+Changes are Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+
+This library 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; either version 2.1 of the License, or (at your option) any later version.
+
+This library 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.
+
+You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
diff --git a/doc/extras/PySide.QtMultimedia.rst b/doc/extras/PySide.QtMultimedia.rst
new file mode 100644
index 0000000..540a706
--- /dev/null
+++ b/doc/extras/PySide.QtMultimedia.rst
@@ -0,0 +1,7 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtMultimedia
+
+
diff --git a/doc/extras/PySide.QtNetwork.rst b/doc/extras/PySide.QtNetwork.rst
new file mode 100644
index 0000000..44249d3
--- /dev/null
+++ b/doc/extras/PySide.QtNetwork.rst
@@ -0,0 +1,5 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtNetwork
diff --git a/doc/extras/PySide.QtOpenGL.rst b/doc/extras/PySide.QtOpenGL.rst
new file mode 100644
index 0000000..1758ee0
--- /dev/null
+++ b/doc/extras/PySide.QtOpenGL.rst
@@ -0,0 +1,14 @@
+OpenGL is a standard API for rendering 3D graphics. OpenGL only deals with 3D rendering and provides little or no support for GUI programming issues. The user interface for an OpenGL application must be created with another toolkit, such as Motif on the X platform, Microsoft Foundation Classes (MFC) under Windows, or Qt on both platforms.
+
+.. note:: OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries.
+
+The Qt OpenGL module makes it easy to use OpenGL in Qt applications. It provides an OpenGL widget class that can be used just like any other Qt widget, except that it opens an OpenGL display buffer where you can use the OpenGL API to render the contents.
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtOpenGL
+
+The Qt OpenGL module is implemented as a platform-independent wrapper around the platform-dependent GLX (version 1.3 or later), WGL, or AGL C APIs. Although the basic functionality provided is very similar to Mark Kilgard's GLUT library, applications using the Qt OpenGL module can take advantage of the whole Qt API for non-OpenGL-specific GUI functionality.
+
+The QtOpenGL module is available on Windows, X11 and Mac OS X. Qt for Embedded Linux and OpenGL supports OpenGL ES (OpenGL for Embedded Systems). \ No newline at end of file
diff --git a/doc/extras/PySide.QtScript.rst b/doc/extras/PySide.QtScript.rst
new file mode 100644
index 0000000..00488cb
--- /dev/null
+++ b/doc/extras/PySide.QtScript.rst
@@ -0,0 +1,21 @@
+The QtScript module only provides core scripting facilities; the QtScriptTools module provides additional Qt Script-related components that application developers may find useful.
+
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtScript
+
+License Information
+-------------------
+
+Qt Commercial Edition licensees that wish to distribute applications that use the QtScript module need to be aware of their obligations under the GNU Library General Public License (LGPL).
+
+Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL.
+QtScript is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code.
+
+This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+This library 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 Library General Public License for more details.
+
+You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
diff --git a/doc/extras/PySide.QtScriptTools.rst b/doc/extras/PySide.QtScriptTools.rst
new file mode 100644
index 0000000..c3f6907
--- /dev/null
+++ b/doc/extras/PySide.QtScriptTools.rst
@@ -0,0 +1,5 @@
+Applications that use the Qt Script Tools classes need to be configured to be built against the QtScriptTools module. To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtScriptTools
diff --git a/doc/extras/PySide.QtSql.rst b/doc/extras/PySide.QtSql.rst
new file mode 100644
index 0000000..41c1794
--- /dev/null
+++ b/doc/extras/PySide.QtSql.rst
@@ -0,0 +1,5 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtSql
diff --git a/doc/extras/PySide.QtSvg.rst b/doc/extras/PySide.QtSvg.rst
new file mode 100644
index 0000000..b106452
--- /dev/null
+++ b/doc/extras/PySide.QtSvg.rst
@@ -0,0 +1,16 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtSvg
+
+License Information
+-------------------
+
+Some code for arc handling in this module is derived from code with the following license:
+
+Copyright 2002 USC/Information Sciences Institute
+
+Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Information Sciences Institute not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. Information Sciences Institute makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.
+
+INFORMATION SCIENCES INSTITUTE DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL INFORMATION SCIENCES INSTITUTE BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
diff --git a/doc/extras/PySide.QtWebKit.rst b/doc/extras/PySide.QtWebKit.rst
new file mode 100644
index 0000000..7a165be
--- /dev/null
+++ b/doc/extras/PySide.QtWebKit.rst
@@ -0,0 +1,94 @@
+QtWebKit provides a Web browser engine that makes it easy to embed content from the World Wide Web into your Qt application. At the same time Web content can be enhanced with native controls.
+
+QtWebKit provides facilities for rendering of HyperText Markup Language (HTML), Extensible HyperText Markup Language (XHTML) and Scalable Vector Graphics (SVG) documents, styled using Cascading Style Sheets (CSS) and scripted with JavaScript.
+
+A bridge between the JavaScript execution environment and the Qt object model makes it possible for custom QObjects to be scripted. Integration with the Qt networking module enables Web pages to be transparently loaded from Web servers, the local file system or even the Qt resource system.
+
+In addition to providing pure rendering features, HTML documents can be made fully editable to the user through the use of the contenteditable attribute on HTML elements.
+
+QtWebKit is based on the Open Source WebKit engine. More information about WebKit itself can be found on the _`WebKit Open Source Project <http://webkit.org/>` Web site.
+
+Including In Your Project
+-------------------------
+
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtWebKit
+
+
+.. note:: Web site icons, also known as "FavIcons", are currently not supported on Windows. We plan to address this in a future release.
+
+Architecture
+------------
+
+The easiest way to render content is through the QWebView class. As a widget it can be embedded into your forms or a graphics view, and it provides convenience functions for downloading and rendering web sites.
+
+::
+
+ view = QWebView(parent)
+ view.load(QUrl("http://qt.nokia.com/"))
+ view.show()
+
+QWebView is used to view Web pages. An instance of QWebView has one QWebPage. QWebPage provides access to the document structure in a page, describing features such as frames, the navigation history, and the undo/redo stack for editable content.
+
+HTML documents can be nested using frames in a frameset. An individual frame in HTML is represented using the QWebFrame class. This class includes the bridge to the JavaScript window object and can be painted using QPainter. Each QWebPage has one QWebFrame object as its main frame, and the main frame may contain many child frames.
+
+Individual elements of an HTML document can be accessed via DOM JavaScript interfaces from within a web page. The equivalent of this API in QtWebKit is represented by QWebElement. QWebElement objects are obtained using QWebFrame's findAllElements() and findFirstElement() functions with CSS selector queries.
+
+Common web browser features, defaults and other settings can be configured through the QWebSettings class. It is possible to provide defaults for all QWebPage instances through the default settings. Individual attributes can be overidden by the page specific settings object.
+
+Netscape Plugin Support
+-----------------------
+
+.. note:: Netscape plugin support is only available on desktop platforms.
+
+Since WebKit supports the Netscape Plugin API, Qt applications can display Web pages that embed common plugins on platforms for which those plugins are available. To enable plugin support, the user must have the appropriate binary files for those plugins installed and the ``QWebSettings.PluginsEnabled`` attribute must be enabled for the application.
+
+The following locations are searched for plugins:
+
+* Linux/Unix (X11)
+ * .mozilla/plugins in the user's home directory
+ * .netscape/plugins in the user's home directory
+ * System locations, such as
+ * /usr/lib/browser/plugins
+ * /usr/local/lib/mozilla/plugins
+ * /usr/lib/firefox/plugins
+ * /usr/lib64/browser-plugins
+ * /usr/lib/browser-plugins
+ * /usr/lib/mozilla/plugins
+ * /usr/local/netscape/plugins
+ * /opt/mozilla/plugins
+ * /opt/mozilla/lib/plugins
+ * /opt/netscape/plugins
+ * /opt/netscape/communicator/plugins
+ * /usr/lib/netscape/plugins
+ * /usr/lib/netscape/plugins-libc5
+ * /usr/lib/netscape/plugins-libc6
+ * /usr/lib64/netscape/plugins
+ * /usr/lib64/mozilla/plugins
+ * Locations specified by environment variables:
+ * $MOZILLA_HOME/plugins
+ * $MOZ_PLUGIN_PATH
+ * $QTWEBKIT_PLUGIN_PATH
+* Windows
+ * The user's Application Data\Mozilla\plugins directory
+ * Standard system locations of plugins for Quicktime, Flash, etc.
+* Mac OS X
+ * Library/Internet Plug-Ins in the user's home directory
+ * The system /Library/Internet Plug-Ins directory
+
+License Information
+-------------------
+
+Qt Commercial Edition licensees that wish to distribute applications that use the QtWebKit module need to be aware of their obligations under the GNU Library General Public License (LGPL).
+
+Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL.
+WebKit is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code.
+
+This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+This library 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 Library General Public License for more details.
+
+You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. \ No newline at end of file
diff --git a/doc/extras/PySide.QtXml.rst b/doc/extras/PySide.QtXml.rst
new file mode 100644
index 0000000..ba69e50
--- /dev/null
+++ b/doc/extras/PySide.QtXml.rst
@@ -0,0 +1,5 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtXml
diff --git a/doc/extras/PySide.QtXmlPatterns.rst b/doc/extras/PySide.QtXmlPatterns.rst
new file mode 100644
index 0000000..0431aaf
--- /dev/null
+++ b/doc/extras/PySide.QtXmlPatterns.rst
@@ -0,0 +1,35 @@
+To include the definitions of the module's classes, use the following directive:
+
+::
+
+ import PySide.QtXmlPatterns
+
+Further Reading
+---------------
+
+General overviews of XQuery and XSchema can be found in the XQuery document.
+
+An introduction to the XQuery language can be found in A Short Path to XQuery.
+
+License Information
+-------------------
+
+The XML Schema implementation provided by this module contains the xml.xsd file (located in src/xmlpatterns/schema/schemas) which is licensed under the terms given below. This module is always built with XML Schema support enabled.
+
+W3C© SOFTWARE NOTICE AND LICENSE
+
+This license came from: http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
+
+This work (and included software, documentation such as READMEs, or other related items) is being provided by the copyright holders under the following license. By obtaining, using and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
+
+Permission to copy, modify, and distribute this software and its documentation, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the software and documentation or portions thereof, including modifications:
+
+* The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
+* Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software Short Notice should be included (hypertext is preferred, text is permitted) within the body of any redistributed or derivative code.
+* Notice of any changes or modifications to the files, including the date changes were made. (We recommend you provide URIs to the location from which the code is derived.)
+
+THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
+
+COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
+
+The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the software without specific, written prior permission. Title to copyright in this software and any associated documentation will at all times remain with copyright holders.
diff --git a/doc/extras/PySide.phonon.rst b/doc/extras/PySide.phonon.rst
new file mode 100644
index 0000000..0a9c21c
--- /dev/null
+++ b/doc/extras/PySide.phonon.rst
@@ -0,0 +1,34 @@
+Phonon is a cross-platform multimedia framework that enables the use of audio and video content in Qt applications. The Phonon Overview document provides an introduction to the architecture and features included in Phonon. The Phonon namespace contains a list of all classes, functions and namespaces provided by the module.
+
+To include the definitions of modules classes, use the following directive:
+
+::
+
+ import PySide.phonon
+
+Qt Backends
+-----------
+
+Qt Backends are currently developed for Phonon version 4.1. The Phonon project has moved on and introduced new features that the Qt Backends do not implement. We have chosen not to document the part of Phonon that we do not support. Any class or function not appearing in our documentation can be considered unsupported.
+
+License Information
+-------------------
+
+Qt Commercial Edition licensees that wish to distribute applications that use the Phonon module need to be aware of their obligations under the GNU Lesser General Public License (LGPL).
+
+Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL; version 2.1 for applications and libraries licensed under the GNU GPL version 2, or version 3 for applications and libraries licensed under the GNU GPL version 3.
+
+This file is part of the KDE project
+
+* Copyright (C) 2004-2009 Matthias Kretz <kretz@kde.org>
+* Copyright (C) 2008 Ian Monroe <ian@monroe.nu>
+* Copyright (C) 2007-2008 Trolltech ASA
+* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
+
+Contact: Nokia Corporation (qt-info@nokia.com)
+
+This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License version 2 as published by the Free Software Foundation.
+
+This library 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 Library General Public License for more details.
+
+You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.