qt-solutions/qtpropertybrowser/doc/index.qdoc

/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Solutions component.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of Digia Plc and its Subsidiary(-ies) nor the names
**     of its contributors may be used to endorse or promote products derived
**     from this software without specific prior written permission.
**
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
	\page index.html
	\title Property Browser

    	\section1 Description
	
            A property browser framework enabling the user to edit a
            set of properties.
	

	
            The framework provides a browser widget that displays the
            given properties with labels and corresponding editing
            widgets (e.g. line edits or comboboxes). The various types
            of editing widgets are provided by the framework's editor
            factories: For each property type, the framework provides
            a property manager (e.g. QtIntPropertyManager and
            QtStringPropertyManager) which can be associated with the
            preferred editor factory (e.g. QtSpinBoxFactory and
            QtLineEditFactory). The framework also provides a variant
            based property type with corresponding variant manager and
            factory. Finally, the framework provides three ready-made
            implementations of the browser widget:
            QtTreePropertyBrowser, QtButtonPropertyBrowser and QtGroupBoxPropertyBrowser.
	

    	
        \section1 Classes
	    \list
	 \i  QtProperty \i  QtVariantProperty \i  QtAbstractPropertyManager \i  QtBoolPropertyManager \i  QtColorPropertyManager \i  QtCursorPropertyManager \i  QtDatePropertyManager \i  QtDateTimePropertyManager \i  QtDoublePropertyManager \i  QtEnumPropertyManager \i  QtFlagPropertyManager \i  QtFontPropertyManager \i  QtGroupPropertyManager \i  QtIntPropertyManager \i  QtKeySequencePropertyManager \i  QtCharPropertyManager \i  QtLocalePropertyManager \i  QtPointPropertyManager \i  QtPointFPropertyManager \i  QtRectPropertyManager \i  QtRectFPropertyManager \i  QtSizePropertyManager \i  QtSizeFPropertyManager \i  QtSizePolicyPropertyManager \i  QtStringPropertyManager \i  QtTimePropertyManager \i  QtVariantPropertyManager \i  QtAbstractEditorFactoryBase \i  QtAbstractEditorFactory \i  QtCheckBoxFactory \i  QtDateEditFactory \i  QtDateTimeEditFactory \i  QtDoubleSpinBoxFactory \i  QtEnumEditorFactory \i  QtLineEditFactory \i  QtScrollBarFactory \i  QtSliderFactory \i  QtSpinBoxFactory \i  QtTimeEditFactory \i  QtColorEditorFactory \i  QtFontEditorFactory \i  QtVariantEditorFactory \i  QtBrowserItem \i  QtAbstractPropertyBrowser \i  QtButtonPropertyBrowser \i  QtGroupBoxPropertyBrowser \i  QtTreePropertyBrowser\endlist
	
        \section1 Examples
	    \list
	 \i  \link qtpropertybrowser-example-simple.html Simple \endlink  \i  \link qtpropertybrowser-example-demo.html Demo \endlink  \i  \link qtpropertybrowser-example-canvas_typed.html Canvas Typed \endlink  \i  \link qtpropertybrowser-example-canvas_variant.html Canvas Variant \endlink  \i  \link qtpropertybrowser-example-extension.html Extension \endlink  \i  \link qtpropertybrowser-example-decoration.html Decoration \endlink  \i  \link qtpropertybrowser-example-object_controller.html Object Controller \endlink \endlist
	
    

    	

    	
    		\section1 Tested platforms
		\list
		\i Qt 4.4, 4.5 / Windows XP / MSVC.NET 2008
		    \i Qt 4.4, 4.5 / Linux / gcc
		    \i Qt 4.4, 4.5 / MacOS X 10.5 / gcc
		    \endlist

    	

	
		\section1 Screenshots

    		\img qttreepropertybrowser.png
		    \img qtbuttonpropertybrowser.png
		    \img qtgroupboxpropertybrowser.png
		    
*/