peranger/qskinny
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

started to work on a C++ doxygen docmentation

Browse Source
This commit is contained in:
Uwe Rathmann 2019-11-25 14:06:20 +01:00
parent f7d658c9b8
commit 556475cca6
131 changed files with 1373 additions and 1129 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -11,3 +11,7 @@ qvg
*.swp
qskinny.pro.user
*.o
*.log
Doxyfile
html
parser

609
doc/Doxyfile
View File

File diff suppressed because it is too large Load Diff

60
doc/DoxygenLayout.xml
View File

@ -1,22 +1,36 @@
<doxygenlayout version="1.0">
<!-- Generated by doxygen 1.8.11 -->
<!-- Generated by doxygen 1.8.16 -->
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="no" title="Pages" intro=""/>
<tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="no" title="">
<tab type="namespacelist" visible="no" title="" intro=""/>
<tab type="namespacemembers" visible="no" title="" intro=""/>
<tab type="pages" visible="no" title="" intro=""/>
<tab type="modules" visible="no" title="Grouped Classes" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
<tab type="namespacemembers" visible="yes" title="" intro=""/>
</tab>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title="Index"/>
<tab type="classes" visible="no" title="">
<tab type="classlist" visible="no" title="" intro=""/>
<tab type="hierarchy" visible="no" title="" intro=""/>
<tab type="classmembers" visible="no" title="" intro=""/>
<tab type="interfaces" visible="yes" title="">
<tab type="interfacelist" visible="yes" title="" intro=""/>
<tab type="interfaceindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="interfacehierarchy" visible="yes" title="" intro=""/>
</tab>
<tab type="classes" visible="yes" title="">
<tab type="classlist" visible="yes" title="" intro=""/>
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="hierarchy" visible="yes" title="" intro=""/>
<tab type="classmembers" visible="yes" title="" intro=""/>
</tab>
<tab type="structs" visible="yes" title="">
<tab type="structlist" visible="yes" title="" intro=""/>
<tab type="structindex" visible="$ALPHABETICAL_INDEX" title=""/>
</tab>
<tab type="exceptions" visible="yes" title="">
<tab type="exceptionlist" visible="yes" title="" intro=""/>
<tab type="exceptionindex" visible="$ALPHABETICAL_INDEX" title=""/>
<tab type="exceptionhierarchy" visible="yes" title="" intro=""/>
</tab>
<tab type="filelist" visible="yes" title="Files" intro=""/>
<tab type="files" visible="no" title="">
<tab type="filelist" visible="no" title="" intro=""/>
<tab type="globals" visible="no" title="" intro=""/>
</tab>
<tab type="examples" visible="yes" title="" intro=""/>
@ -33,11 +47,10 @@
<publictypes title=""/>
<services title=""/>
<interfaces title=""/>
<properties title=""/>
<publicslots title=""/>
<signals title=""/>
<publicmethods title=""/>
<publicstaticmethods title=""/>
<publicslots title=""/>
<publicattributes title=""/>
<publicstaticattributes title=""/>
<protectedtypes title=""/>
@ -51,6 +64,7 @@
<packagestaticmethods title=""/>
<packageattributes title=""/>
<packagestaticattributes title=""/>
<properties title=""/>
<events title=""/>
<privatetypes title=""/>
<privateslots title=""/>
@ -87,8 +101,13 @@
<memberdecl>
<nestednamespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
<interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<structs visible="yes" title=""/>
<exceptions visible="yes" title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -98,6 +117,8 @@
<memberdef>
<inlineclasses title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -113,11 +134,16 @@
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
<sourcelink visible="yes"/>
<memberdecl>
<interfaces visible="yes" title=""/>
<classes visible="yes" title=""/>
<structs visible="yes" title=""/>
<exceptions visible="yes" title=""/>
<namespaces visible="yes" title=""/>
<constantgroups visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -128,6 +154,8 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<functions title=""/>
<variables title=""/>
@ -147,6 +175,8 @@
<classes visible="yes" title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>
@ -166,6 +196,8 @@
<inlineclasses title=""/>
<defines title=""/>
<typedefs title=""/>
<sequences title=""/>
<dictionaries title=""/>
<enums title=""/>
<enumvalues title=""/>
<functions title=""/>

BIN
doc/automotive-screenshot.jpg
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 101 KiB

2
doc/classes/QskAbstractButton.metadox
View File

@ -8,6 +8,6 @@ INTERFACE
HEADER: QskAbstractButton.h
DESCRIPTION
\brief Base class of all Qsk buttons
\brief Base class of all buttons
END
END

12
doc/classes/QskAnimation.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskAnimation.h
\brief Yet another system for animations
*/
class QskAnimation
{
/*!
*/
};

9
doc/classes/QskAnimationHint.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskAnimationHint
HEADER: QskAnimationHint.h
DESCRIPTION
\brief QskAnimationHint
END
END

9
doc/classes/QskAnimator.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskAnimator
HEADER: QskAnimator.h
DESCRIPTION
\brief QskAnimator
END
END

11
doc/classes/QskArcIterator.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskArcIterator.h
\brief A helper class for interpolating an arc with lines
*/
class QskArcIterator
{
/*!
*/
};

0
doc/classes/QskAspect.dox → doc/classes/QskAspect.metadox
View File

11
doc/classes/QskBorder.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskBorder.h
\brief Border attributes that can be used from QML
*/
class QskBorder
{
/*!
*/
};

13
doc/classes/QskBox.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskBox
BASE: QskControl
QMLCLASS: Box
QMLBASE: Control
HEADER: QskBox.h
DESCRIPTION
\brief QskBox
END
END

9
doc/classes/QskBoxBorderColors.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskBoxBorderColors
HEADER: QskBoxBorderColors.h
DESCRIPTION
\brief QskBoxBorderColors
END
END

10
doc/classes/QskBoxBorderMetrics.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskBoxBorderMetrics
BASE: QskBoxBorderMetrics
HEADER: QskBoxBorderMetrics.h
DESCRIPTION
\brief Something
END
END

10
doc/classes/QskBoxClipNode.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskBoxClipNode
BASE: QSGClipNode
HEADER: QskBoxClipNode.h
DESCRIPTION
\brief QskBoxClipNode
END
END

10
doc/classes/QskBoxNode.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskBoxNode
BASE: QSGGeometryNode
HEADER: QskBoxNode.h
DESCRIPTION
\brief QskBoxNode
END
END

9
doc/classes/QskBoxShapeMetrics.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskBoxShapeMetrics
HEADER: QskBoxShapeMetrics.h
DESCRIPTION
\brief QskBoxShapeMetrics
END
END

10
doc/classes/QskBoxSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskBoxSkinlet
BASE: QskSkinlet
HEADER: QskBoxSkinlet.h
DESCRIPTION
\brief QskBoxSkinlet
END
END

13
doc/classes/QskClipNode.dox
View File

@ -1,13 +0,0 @@
/*!
\headerfile QskClipNode.h
\brief A clip node for rectangles with rounded borders
\sa QskVertexRenderer
*/
class QskClipNode
{
/*!
*/
};

9
doc/classes/QskColorFilter.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskColorFilter
HEADER: QskColorFilter.h
DESCRIPTION
\brief QskColorFilter
END
END

2
doc/classes/QskControl.metadox
View File

@ -1,6 +1,6 @@
INTERFACE
CLASS: QskControl
BASE: QQuickItem
BASE: QskQuickItem
QMLCLASS: Control
QMLBASE: Item

11
doc/classes/QskCorner.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskCorner.h
\brief Attributes of a rounded corner that can be used from QML
*/
class QskCorner
{
/*!
*/
};

13
doc/classes/QskDialogButton.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskDialogButton
BASE: QskPushButton
QMLCLASS: DialogButton
QMLBASE: Button
HEADER: QskDialogButton.h
DESCRIPTION
\brief QskDialogButton
END
END

2
doc/classes/QskDialogButtonBox.metadox
View File

@ -1,6 +1,6 @@
INTERFACE
CLASS: QskDialogButtonBox
BASE: QskControl
BASE: QskBox
QMLCLASS: DialogButtonBox
QMLBASE: Control

13
doc/classes/QskDialogSubWindow.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskDialogSubWindow
BASE: QskSubWindow
QMLCLASS: DialogSubWindow
QMLBASE: SubWindow
HEADER: QskDialogSubWindow.h
DESCRIPTION
\brief QskDialogSubWindow
END
END

13
doc/classes/QskDialogWindow.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskDialogWindow
BASE: QskWindow
QMLCLASS: DialogWindow
QMLBASE: Window
HEADER: QskDialogWindow.h
DESCRIPTION
\brief QskDialogWindow
END
END

10
doc/classes/QskFlickAnimator.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskFlickAnimator
BASE: QskAnimator
HEADER: QskFlickAnimator.h
DESCRIPTION
\brief QskFlickAnimator
END
END

12
doc/classes/QskFocusIndicatorSkinlet.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskFocusIndicatorSkinlet.h
\brief Base class of all skinlets for QskFocusIndicator
*/
class QskFocusIndicatorSkinlet
{
/*!
*/
};

10
doc/classes/QskFocusIndicatorSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskFocusIndicatorSkinlet
BASE: QskSkinlet
HEADER: QskFocusIndicatorSkinlet.h
DESCRIPTION
\brief QskFocusIndicatorSkinlet
END
END

13
doc/classes/QskFrame.metadox
View File

@ -1,13 +0,0 @@
INTERFACE
CLASS: QskFrame
BASE: QskControl
QMLCLASS: Frame
QMLBASE: Control
HEADER: QskFrame.h
DESCRIPTION
\brief A container with a frame
END
END

13
doc/classes/QskFrameNode.dox
View File

@ -1,13 +0,0 @@
/*!
\headerfile QskFrameNode.h
\brief A geometry node for displaying a frame
\sa QskVertexRendererColored
*/
class QskFrameNode
{
/*!
*/
};

11
doc/classes/QskFrameSkinlet.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskFrameSkinlet.h
\brief Base class of all skinlets for QskFrame
*/
class QskFrameSkinlet
{
/*!
*/
};

19
doc/classes/QskGeometry.dox
View File

@ -1,19 +0,0 @@
/*! \namespace QskGeometry
\brief A collection of utility classes for manipulating Scene Graph geometry.
*/
/*! \class QskSimpleBorderGeometry
\brief A convenience class for managing nine-patch images. To be used with
materials rendering textured vertices, such as QSGTextureMaterial or
QskFlatColorSymbolMaterial. To combine per-vertex colors with textured
materials, use QskColoredBorderGeometry.
*/
/*! \class QskColoredBorderGeometry
\brief A convenience class for managing nine-patch images. To be used with
materials providing per-vertex colored textured vertices, such as
QskVertexColoredSymbolMaterial.
*/

9
doc/classes/QskGesture.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskGesture
HEADER: QskGesture.h
DESCRIPTION
\brief QskGesture
END
END

9
doc/classes/QskGestureRecognizer.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskGestureRecognizer
HEADER: QskGestureRecognizer.h
DESCRIPTION
\brief QskGestureRecognizer
END
END

9
doc/classes/QskGradient.dox
View File

@ -1,9 +0,0 @@
/*! \class QskGradientStop
\brief A color stop of a QskGradient
*/
/*! \class QskGradient
\brief Attributes of a linear gradient that can be set from QML
*/

10
doc/classes/QskGradient.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS : QskGradientStop
QMLCLASS: GradientStop
HEADER: QskGradient.h
DESCRIPTION
\brief A color stop of a gradient
END
END

51
doc/classes/QskGraphic.dox
View File

@ -1,51 +0,0 @@
/*!
\headerfile QskGraphic.h
\brief A paint device for scalable graphics
QskGraphic is the representation of a graphic that is tailored for
scalability. Like QPicture it will be initialized by QPainter
operations and can be replayed later to any target paint device.
It can be stored and loaded from disk using the operators
from QskGraphicIO. Together with QSvgRenderer it can be used to
implement a simple SVG compiler.
QskGraphic maps all scalable drawing primitives to a QPainterPath
and stores them together with the painter state changes
( pen, brush, transformation ... ) in a list of QskPainterCommand.
For being a complete QPaintDevice it also stores pixmaps or images,
what is somehow against the idea of the class, because these objects
can't be scaled without a loss in quality.
The main issue about scaling a QskGraphic object are the pens used for
drawing the outlines of the painter paths. While non cosmetic pens
( QPen::isCosmetic() ) are scaled with the same ratio as the path,
cosmetic pens have a fixed width. A graphic might have paths with
different pens - cosmetic and non-cosmetic.
QskGraphic caches 2 different rectangles:
- control point rectangle\n
The control point rectangle is the bounding rectangle of all
control point rectangles of the painter paths, or the target
rectangle of the pixmaps/images.
- bounding rectangle\n
The bounding rectangle extends the control point rectangle by
what is needed for rendering the outline with an unscaled pen.
Because the offset for drawing the outline depends on the shape
of the painter path ( the peak of a triangle is different than the flat side )
scaling with a fixed aspect ratio always needs to be calculated from the
control point rectangle.
\sa QskGraphicIO, QskPainterCommand
\note This class is a clone of QwtGraphic ( http://qwt.sf.net/class_qwt_graphic.html )
*/
class QskGraphic
{
/*!
*/
};

48
doc/classes/QskGraphic.metadox Normal file
View File

@ -0,0 +1,48 @@
INTERFACE
CLASS: QskGraphic
BASE: QPaintDevice
HEADER: QskGraphic.h
DESCRIPTION
\brief A paint device for scalable graphics
QskGraphic is the representation of a graphic that is tailored for
scalability. Like QPicture it will be initialized by QPainter
operations and can be replayed later to any target paint device.
It can be stored and loaded from disk using the operators
from QskGraphicIO. Together with QSvgRenderer it can be used to
implement a simple SVG compiler.
QskGraphic maps all scalable drawing primitives to a QPainterPath
and stores them together with the painter state changes
( pen, brush, transformation ... ) in a list of QskPainterCommand.
For being a complete QPaintDevice it also stores pixmaps or images,
what is somehow against the idea of the class, because these objects
can't be scaled without a loss in quality.
The main issue about scaling a QskGraphic object are the pens used for
drawing the outlines of the painter paths. While non cosmetic pens
( QPen::isCosmetic() ) are scaled with the same ratio as the path,
cosmetic pens have a fixed width. A graphic might have paths with
different pens - cosmetic and non-cosmetic.
QskGraphic caches 2 different rectangles:
- control point rectangle\n
The control point rectangle is the bounding rectangle of all
control point rectangles of the painter paths, or the target
rectangle of the pixmaps/images.
- bounding rectangle\n
The bounding rectangle extends the control point rectangle by
what is needed for rendering the outline with an unscaled pen.
Because the offset for drawing the outline depends on the shape
of the painter path ( the peak of a triangle is different than the flat side )
scaling with a fixed aspect ratio always needs to be calculated from the
control point rectangle.
\sa QskGraphicIO, QskPainterCommand
END
END

0
doc/classes/QskGraphicIO.dox → doc/classes/QskGraphicIO.metadox
View File

18
doc/classes/QskGraphicImageProvider.dox
View File

@ -1,18 +0,0 @@
/*!
\headerfile QskGraphicImageProvider.h
\brief A QQuickImageProvider making QskGraphicProvider available
for QQuickImage items.
QskGraphicImageProvider supports images, pixmaps or textures, but only
when requesting a QQuickTextureFactory the item will be able to
scale the image without a loss in quality.
\sa QskGraphicTextureFactory, QskGraphicProvider, Qsk::addGraphicProvider
*/
class QskGraphicImageProvider
{
/*!
*/
};

17
doc/classes/QskGraphicImageProvider.metadox Normal file
View File

@ -0,0 +1,17 @@
INTERFACE
CLASS: QskGraphicImageProvider
BASE: QQuickImageProvider
HEADER QskGraphicImageProvider.h
DESCRIPTION
\brief A QQuickImageProvider making QskGraphicProvider available
for QQuickImage items.
QskGraphicImageProvider supports images, pixmaps or textures, but only
when requesting a QQuickTextureFactory the item will be able to
scale the image without a loss in quality.
\sa QskGraphicTextureFactory, QskGraphicProvider, Qsk::addGraphicProvider
END
END

10
doc/classes/QskGraphicLabelSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskGraphicLabelSkinlet
BASE: QskSkinlet
HEADER: QskGraphicLabelSkinlet.h
DESCRIPTION
\brief QskGraphicLabelSkinlet
END
END

10
doc/classes/QskGraphicNode.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskGraphicNode
BASE: QskTextureNode
HEADER: QskGraphicNode.h
DESCRIPTION
\brief QskGraphicNode
END
END

11
doc/classes/QskGraphicPaintEngine.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskGraphicPaintEngine.h
\brief The paint engine for QskGraphic
*/
class QskGraphicPaintEngine
{
/*!
*/
};

18
doc/classes/QskGraphicPaintFilter.dox
View File

@ -1,18 +0,0 @@
/*!
\headerfile QskGraphicPaintFilter.h
\brief A filter for substituting colors of a QskGraphic
A color filter can be used to avoid having to create
variations of an image for different color themes.
\sa QskGraphic::render(), QskGraphicLabel::setGraphicFilter(),
QskGraphicTextureFactory::setGraphicFilter()
*/
class QskGraphicPaintFilter
{
/*!
*/
};

13
doc/classes/QskGraphicProvider.dox
View File

@ -1,13 +0,0 @@
/*!
\headerfile QskGraphicProvider.h
\brief QskGraphicProvider loads QskGraphic from a source URL.
\sa QskGraphicImageProvider, Qsk::addGraphicProvider
*/
class QskGraphicProvider
{
/*!
*/
};

11
doc/classes/QskGraphicProvider.metadox Normal file
View File

@ -0,0 +1,11 @@
INTERFACE
CLASS: QskGraphicProvider
BASE: QObject
HEADER: QskGraphicProvider.h
DESCRIPTION
\brief QskGraphicProvider loads QskGraphic from a source URL.
\sa QskGraphicImageProvider, Qsk::addGraphicProvider
END
END

9
doc/classes/QskGraphicProviderMap.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskGraphicProviderMap
HEADER: QskGraphicProviderMap.h
DESCRIPTION
\brief QskGraphicProviderMap
END
END

16
doc/classes/QskGraphicTextureFactory.dox
View File

@ -1,16 +0,0 @@
/*!
\headerfile QskGraphicTextureFactory.h
\brief A QQuickTextureFactory creating a QSGTexture from a QskGraphic.
QskGraphicTextureFactory is a helper class to forward the creation
of textures for QQuickImage to the scene graph thread.
\sa QskGraphicImageProvider
*/
class QskGraphicTextureFactory
{
/*!
*/
};

15
doc/classes/QskGraphicTextureFactory.metadox Normal file
View File

@ -0,0 +1,15 @@
INTERFACE
CLASS: QskGraphicTextureFactory
BASE: QQuickTextureFactory
HEADER: QskGraphicTextureFactory.h
DESCRIPTION
\brief A QQuickTextureFactory creating a QSGTexture from a QskGraphic.
QskGraphicTextureFactory is a helper class to forward the creation
of textures for QQuickImage to the scene graph thread.
\sa QskGraphicImageProvider
END
END

10
doc/classes/QskHintAnimator.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskHintAnimator
BASE: QskVariantAnimator
HEADER: QskHintAnimator.h
DESCRIPTION
\brief QskHintAnimator
END
END

16
doc/classes/QskImage.metadox
View File

@ -1,16 +0,0 @@
INTERFACE
CLASS: QskImage
BASE: QQuickImage
QMLCLASS: Image
# Not true as we inherit from QQuickImage ( = Image )
# how to solve this ???
QMLBASE: Item
HEADER: QskImage.h
DESCRIPTION
\brief An extended version of QQuickImage
END
END

92
doc/classes/QskLayout.metadox
View File

@ -1,92 +0,0 @@
INTERFACE
CLASS: QskLayout
BASE: QskControl
QMLCLASS: Layout
QMLBASE: Control
HEADER: QskLayout.h
DESCRIPTION
\brief Base class of all Qsk layouts using a QGridLayoutEngine workhorse
END
INVOKABLE
SIGNATURE: bool isEmpty() const;
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: int itemCount() const;
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: QUICKITEM itemAtIndex( int index ) const;
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: int indexOf( const QUICKITEM item ) const;
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: removeItem( const QUICKITEM item );
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: void removeAt( int index );
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: void clear();
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: void setActive( bool on );
DESCRIPTION
END
END
INVOKABLE
SIGNATURE: bool isActive() const;
DESCRIPTION
END
END
SLOT
SIGNATURE: void activate();
DESCRIPTION
END
END
SLOT
SIGNATURE: void invalidate();
DESCRIPTION
END
END
FUNCTION
SIGNATURE: void adjustItem( const QUICKITEM item );
DESCRIPTION
END
END
FUNCTION
SIGNATURE: void adjustItemAt( const QUICKITEM item );
DESCRIPTION
END
END
END

12
doc/classes/QskLayoutEngine.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskLayoutEngine.h
\brief A QGridLayoutEngine tailored for Qsk layouts
*/
class QskLayoutEngine
{
/*!
*/
};

11
doc/classes/QskLayoutItem.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskLayoutItem.h
\brief A QGridLayoutItem tailored for Qsk layouts
*/
class QskLayoutItem
{
/*!
*/
};

10
doc/classes/QskListViewSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskListViewSkinlet
BASE: QskSkinlet
HEADER: QskListViewSkinlet.h
DESCRIPTION
\brief QskListViewSkinlet
END
END

10
doc/classes/QskMargins.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskMargins
BASE: QMarginsF
HEADER: QskMargins.h
DESCRIPTION
\brief A stupid wrapper around QMarginsF
END
END

13
doc/classes/QskMessageSubWindow.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskMessageSubWindow
BASE: QskDialogSubWindow
QMLCLASS: MessageSubWindow
QMLBASE: DialogSubWindow
HEADER: QskMessageSubWindow.h
DESCRIPTION
\brief QskMessageSubWindow
END
END

13
doc/classes/QskMessageWindow.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskMessageWindow
BASE: QskDialogWindow
QMLCLASS: MessageWindow
QMLBASE: DialogWindow
HEADER: QskDialogWindow.h
DESCRIPTION
\brief QskDialogWindow
END
END

10
doc/classes/QskModule.dox
View File

@ -1,10 +0,0 @@
/*!
\headerfile QskModule.h
\brief A collection of global methods of the Qsk module.
*/
namespace QskModule
{
/*!
*/
}

12
doc/classes/QskObjectCounter.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskAbstractButton.h
\brief An object counter using Qt hooks to create statistics
about QObject and QQuickItem instantiations
*/
class QskAbstractButton
{
/*!
*/
};

11
doc/classes/QskObjectCounter.metadox Normal file
View File

@ -0,0 +1,11 @@
INTERFACE
CLASS: QskAbstractButton
BASE: QskControl
HEADER: QskAbstractButton.h
DESCRIPTION
\brief An object counter using Qt hooks to create statistics
about QObject and QQuickItem instantiations
END
END

11
doc/classes/QskObjectResolver.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskObjectResolver.h
\brief A helper class for resolving properties on the window/item tree
*/
class QskObjectResolver
{
/*!
*/
};

7
doc/classes/QskObjectWalker.dox
View File

@ -1,7 +0,0 @@
/*! \class QskObjectAttributes
\brief A helper class for resolving properties on the window/item tree
*/
/*! \class QskObjectWalker
\brief A helper class for resolving properties on the window/item tree
*/

13
doc/classes/QskPageIndicator.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskPageIndicator
BASE: QskControl
QMLCLASS: PageIndicator
QMLBASE: Control
HEADER: QskPageIndicator.h
DESCRIPTION
\brief A page indicator
END
END

10
doc/classes/QskPageIndicatorSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskPageIndicatorSkinlet
BASE: QskSkinlet
HEADER: QskPageIndicatorSkinlet.h
DESCRIPTION
\brief QskPageIndicatorSkinlet
END
END

10
doc/classes/QskPaintedNode.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskPaintedNode
BASE: QskTextureNode
HEADER: QskPaintedNode.h
DESCRIPTION
\brief QskPaintedNode
END
END

77
doc/classes/QskPainterCommand.dox
View File

@ -1,77 +0,0 @@
/*!
\headerfile QskPainterCommand.h
\brief Attributes of a QPainter operation.
It is used by QskGraphic to record and replay paint operations
\sa QskGraphic::commands()
*/
class QskPainterCommand
{
/*!
\fn QskPainterCommand()
Construct an invalid command
\fn QskPainterCommand( const QPainterPath &path )
Constructor for path paint operation
\fn QskPainterCommand( const QRectF &rect,
const QPixmap &pixmap, const QRectF& subRect )
Constructor for Pixmap paint operation
\param rect Target rectangle
\param pixmap Pixmap
\param subRect Rectangle inside the pixmap
\sa QPainter::drawPixmap()
\fn QskPainterCommand( const QRectF &rect, const QImage &image,
const QRectF& subRect, Qt::ImageConversionFlags flags )
Constructor for Image paint operation
\param rect Target rectangle
\param image Image
\param subRect Rectangle inside the image
\param flags Conversion flags
\sa QPainter::drawImage()
\fn QskPainterCommand( const QPaintEngineState &state )
Constructor for State paint operation
\param state Paint engine state
\fn QskPainterCommand( const QskPainterCommand &other )
Copy constructor
\param other Command to be copied
\fn ~QskPainterCommand()
Destructor
\fn QskPainterCommand &operator=( const QskPainterCommand &other )
Assignment operator
\param other Command to be copied
\return Modified command
\fn QPainterPath *path()
\return Painter path to be painted
\fn PixmapData* pixmapData()
\return Attributes how to paint a QPixmap
\fn ImageData* imageData()
\return Attributes how to paint a QImage
\fn StateData* stateData()
\return Attributes of a state change
*/
};

10
doc/classes/QskPanGestureRecognizer.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskPanGestureRecognizer
BASE: QskGestureRecognizer
HEADER: QskPanGestureRecognizer.h
DESCRIPTION
\brief QskPanGestureRecognizer
END
END

14
doc/classes/QskPlainTextRenderer.dox
View File

@ -1,14 +0,0 @@
/*!
\headerfile QskPlainTextRenderer.h
\brief A renderer for creating a scene graph subtree from plain text content
\sa QskTextRenderer
*/
class QskPlainTextRenderer
{
/*!
*/
};

13
doc/classes/QskPopup.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskPopup
BASE: QskControl
QMLCLASS: QskPopup
QMLBASE: Control
HEADER: QskPopup.h
DESCRIPTION
\brief Something
END
END

10
doc/classes/QskPopupSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskPopupSkinlet
BASE: QskSkinlet
HEADER: QskPopupSkinlet.h
DESCRIPTION
\brief QskPopupSkinlet
END
END

12
doc/classes/QskPushButtonSkinlet.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskPushButtonSkinlet.h
\brief Base class of all skinlets for QskPushButton
*/
class QskPushButtonSkinlet
{
/*!
*/
};

10
doc/classes/QskPushButtonSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskPushButtonSkinlet
BASE: QskSkinlet
HEADER: QskPushButtonSkinlet.h
DESCRIPTION
\brief QskPushButtonSkinlet
END
END

10
doc/classes/QskQuickItem.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskQuickItem
BASE: QQuickItem
HEADER: QskQuickItem.h
DESCRIPTION
\brief QskQuickItem
END
END

2
doc/classes/QskRangeControl.metadox
View File

@ -8,6 +8,6 @@ INTERFACE
HEADER: QskRangeControl.h
DESCRIPTION
\brief A push button
\brief QskRangeControl
END
END

12
doc/classes/QskRectNode.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskRectNode.h
\brief A scene graph node for rounded rectangles with an optional border
*/
class QskRectNode
{
/*!
*/
};

13
doc/classes/QskRectangle.metadox
View File

@ -1,13 +0,0 @@
INTERFACE
CLASS: QskRectangle
BASE: QskControl
QMLCLASS: Rectangle
QMLBASE: Control
HEADER: QskRectangle.h
DESCRIPTION
\brief An item displaying a filled rectangle with optional borders
END
END

11
doc/classes/QskResizable.dox
View File

@ -1,11 +0,0 @@
/*!
\headerfile QskResizable.h
*/
class QskResizable
{
/*!
*/
};

13
doc/classes/QskScrollArea.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskScrollArea
BASE: QskScrollView
QMLCLASS: ScrollArea
QMLBASE: ScrollView
HEADER: QskScrollArea.h
DESCRIPTION
\brief QskScrollArea
END
END

10
doc/classes/QskScrollViewSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskScrollViewSkinlet
BASE: QskSkinlet
HEADER: QskScrollViewSkinlet.h
DESCRIPTION
\brief QskScrollViewSkinlet
END
END

13
doc/classes/QskSelectionSubWindow.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskSelectionSubWindow
BASE: QskDialogSubWindow
QMLCLASS: SelectionSubWindow
QMLBASE: DialogSubWindow
HEADER: QskSelectionSubWindow.h
DESCRIPTION
\brief QskSelectionSubWindow
END
END

13
doc/classes/QskSelectionWindow.metadox Normal file
View File

@ -0,0 +1,13 @@
INTERFACE
CLASS: QskSelectionWindow
BASE: QskDialogWindow
QMLCLASS: SelectionWindow
QMLBASE: DialogWindow
HEADER: QskSelectionWindow.h
DESCRIPTION
\brief QskSelectionWindow
END
END

10
doc/classes/QskSeparatorSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskSeparatorSkinlet
BASE: QskSkinlet
HEADER: QskSeparatorSkinlet.h
DESCRIPTION
\brief QskSeparatorSkinlet
END
END

9
doc/classes/QskShortcutMap.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskShortcutMap
HEADER: QskShortcutMap.h
DESCRIPTION
\brief QskShortcutMap
END
END

12
doc/classes/QskSizePolicy.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskSizePolicy.h
\brief A size policy ( similar to QSizePolicy )
*/
class QskSizePolicy
{
/*!
*/
};

10
doc/classes/QskSizePolicy.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskSizePolicy
QMLCLASS: SizePolicy
HEADER QskSizePolicy.h
DESCRIPTION
\brief A size policy ( similar to QSizePolicy )
END
END

11
doc/classes/QskSkin.dox → doc/classes/QskSkin.metadox
View File

@ -1,3 +1,14 @@
INTERFACE
CLASS: QskSkin
BASE: QObject
HEADER: QskSkin.h
DESCRIPTION
\brief QskSkin
END
END
/*!
\fn void QskSkin::setColor( QskAspect::Aspect aspect, QRgb color )

35
doc/classes/QskSkinAnimator.dox
View File

@ -1,35 +0,0 @@
/*!
\headerfile QskSkinAnimator.h
\brief A helper class for delegating transitions between skin states. For
example, if you wish to smoothly transition from one color to another, you
should use QskControl::skinAnimator.
QskSkinAnimator is a low-level API which allows for smooth transitions
between values stored by QskSkinHint. Depending on the QskControl::skinState(),
a different value may be returned by a call to QskControl::skinHint().
By specifying an animator for the same QskAspect, an automatic transition
can occur between those two values.
In the simple case, you can create a hint animator by calling
QskSkinlet::animator() to get a default animator for that skin aspect.
Then, set the duration value:
\code
control->skinAnimator( QskSkinHint::Background ).setDuration<500>(); // Set the color transition to 500ms.
\endcode
To animate using an easing curve, you can replace the progress functor with
one utilizing a QEasingCurve:
\code
control->skinAnimator( QskSkinHint::Background ).progress = &QskSkinHint::easingProgress<QEasingCurve::InOutBounce>;
\endcode
*/
class QskSkinAnimator
{
/*!
*/
};

10
doc/classes/QskSkinFactory.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskSkinFactory
BASE: QObject
HEADER: QskSkinFactory.h
DESCRIPTION
\brief QskSkinFactory
END
END

6
doc/classes/QskSkinHint.dox
View File

@ -1,6 +0,0 @@
/*! \struct QskSkinHint
This struct acts as a union between option types used by the framework.
Skin hints are attributes of a given control which affect the visual
representation of the control. They can also be animated using
QskSkinHintAnimator.
*/

9
doc/classes/QskSkinHintTable.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskSkinHintTable
HEADER: QskSkinHintTable.h
DESCRIPTION
\brief QskSkinHintTable
END
END

10
doc/classes/QskSkinManager.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskSkinManager
BASE: QObject
HEADER: QskSkinManager.h
DESCRIPTION
\brief QskSkinManager
END
END

9
doc/classes/QskSkinTransition.metadox Normal file
View File

@ -0,0 +1,9 @@
INTERFACE
CLASS: QskSkinTransition
HEADER: QskSkinTransition.h
DESCRIPTION
\brief QskSkinTransition
END
END

27
doc/classes/QskSkinlet.dox
View File

@ -1,27 +0,0 @@
/*!
\headerfile QskSkinlet.h
\brief Describes the rendering interface of a QskControl. Change the
skinlet to change the appearance of the control using the low-level scene
graph API.
\sa QskControl::setSkinlet()
\sa QskSkin
\sa setMetric()
\sa setColor()
*/
class QskSkinlet
{
/*!
\fn QSGNode* findNode( QSGNode *parent, quint8 nodeRole )
A convenience method for finding the first top level child node
with the given nodeRole.
\param parent Parent node
\param nodeRole Unique identifier
\return the node, if found, or nullptr if not found.
*/
};

16
doc/classes/QskSkinlet.metadox Normal file
View File

@ -0,0 +1,16 @@
INTERFACE
CLASS: QskSkinlet
HEADER: QskSkinlet.h
DESCRIPTION
\brief Describes the rendering interface of a QskControl. Change the
skinlet to change the appearance of the control using the low-level scene
graph API.
\sa QskControl::setSkinlet()
\sa QskSkin
\sa setMetric()
\sa setColor()
END
END

10
doc/classes/QskSkinnable.dox → doc/classes/QskSkinnable.metadox
View File

@ -1,3 +1,13 @@
INTERFACE
CLASS: QskSkinnable
HEADER: QskSkinnable.h
DESCRIPTION
\brief QskSkinnable
END
END
/*!
\fn void QskSkinnable::markDirty( QskAspect::Aspect aspect )

12
doc/classes/QskSliderSkinlet.dox
View File

@ -1,12 +0,0 @@
/*!
\headerfile QskSliderSkinlet.h
\brief Base class of all skinlets for QskSlider
*/
class QskSliderSkinlet
{
/*!
*/
};

10
doc/classes/QskSliderSkinlet.metadox Normal file
View File

@ -0,0 +1,10 @@
INTERFACE
CLASS: QskSliderSkinlet
BASE: QskSkinlet
HEADER: QskSliderSkinlet.h
DESCRIPTION
\brief QskSliderSkinlet
END
END

Some files were not shown because too many files have changed in this diff Show More