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

wip

This commit is contained in:
Uwe Rathmann 2020-12-12 14:05:09 +01:00
parent d5eadee8c5
commit 5f1b45177e
12 changed files with 370 additions and 709 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
doc/Doxyfile
View File

@ -115,7 +115,7 @@ BRIEF_MEMBER_DESC = YES
# brief descriptions will be completely suppressed. # brief descriptions will be completely suppressed.
# The default value is: YES. # The default value is: YES.
REPEAT_BRIEF = YES REPEAT_BRIEF = NO
# This tag implements a quasi-intelligent brief description abbreviator that is # This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found # used to form the text in various listings. Each string in this list, if found
@ -719,7 +719,7 @@ SHOW_USED_FILES = NO
# (if specified). # (if specified).
# The default value is: YES. # The default value is: YES.
SHOW_FILES = YES SHOW_FILES = NO
# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
# page. This will remove the Namespaces entry from the Quick Index and from the # page. This will remove the Namespaces entry from the Quick Index and from the
@ -864,53 +864,7 @@ INPUT_ENCODING = UTF-8
# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
# *.vhdl, *.ucf, *.qsf and *.ice. # *.vhdl, *.ucf, *.qsf and *.ice.
FILE_PATTERNS = *.c \ FILE_PATTERNS =
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.idl \
*.ddl \
*.odl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.doc \
*.txt \
*.py \
*.pyw \
*.f90 \
*.f95 \
*.f03 \
*.f08 \
*.f18 \
*.f \
*.for \
*.vhd \
*.vhdl \
*.ucf \
*.qsf \
*.ice
# The RECURSIVE tag can be used to specify whether or not subdirectories should # The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well. # be searched for input files as well.
@ -1014,7 +968,7 @@ INPUT_FILTER =
# need to set EXTENSION_MAPPING for the extension otherwise the files are not # need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen. # properly processed by doxygen.
FILTER_PATTERNS = FILTER_PATTERNS = *.h=doxyfilter.sh
# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
# INPUT_FILTER) will also be used to filter the input files that are used for # INPUT_FILTER) will also be used to filter the input files that are used for
@ -1295,7 +1249,7 @@ HTML_DYNAMIC_MENUS = YES
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES. # This tag requires that the tag GENERATE_HTML is set to YES.
HTML_DYNAMIC_SECTIONS = YES HTML_DYNAMIC_SECTIONS = NO
# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
# shown in the various tree structured indices initially; the user can expand # shown in the various tree structured indices initially; the user can expand
@ -1777,7 +1731,7 @@ LATEX_MAKEINDEX_CMD = makeindex
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES. # This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO COMPACT_LATEX = YES
# The PAPER_TYPE tag can be used to set the paper type that is used by the # The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer. # printer.
@ -2161,7 +2115,7 @@ MACRO_EXPANSION = YES
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = YES EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES, the include files in the # If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found. # INCLUDE_PATH will be searched if a #include is found.
@ -2195,7 +2149,7 @@ INCLUDE_FILE_PATTERNS =
PREDEFINED = \ PREDEFINED = \
Q_GADGET= \ Q_GADGET= \
QSK_EXPORT= \
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The # tag can be used to specify a list of macro names that should be expanded. The
@ -2204,7 +2158,7 @@ PREDEFINED = \
# definition found in the source code. # definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED = QSK_EXPORT #EXPAND_AS_DEFINED = QSK_SUBCONTROLS QSK_STATES
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have # remove all references to function-like macros that are alone on a line, have
@ -2315,7 +2269,7 @@ DOT_NUM_THREADS = 0
# The default value is: Helvetica. # The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTNAME = DOT_FONTNAME = Helvetica
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs. # dot graphs.
@ -2522,7 +2476,7 @@ PLANTUML_INCLUDE_PATH =
# Minimum value: 0, maximum value: 10000, default value: 50. # Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50 DOT_GRAPH_MAX_NODES = 20
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the # generated by dot. A depth value of 3 means that only nodes reachable from the
@ -2546,7 +2500,7 @@ MAX_DOT_GRAPH_DEPTH = 0
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
DOT_TRANSPARENT = NO DOT_TRANSPARENT = YES
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This # files in one run (i.e. multiple -o and -T options on the command line). This
@ -2563,7 +2517,7 @@ DOT_MULTI_TARGETS = NO
# The default value is: YES. # The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES. # This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES GENERATE_LEGEND = NO
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot # If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
# files that are used to generate the various graphs. # files that are used to generate the various graphs.

4
doc/DoxygenLayout.xml
View File

@ -38,8 +38,9 @@
<!-- Layout definition for a class page --> <!-- Layout definition for a class page -->
<class> <class>
<briefdescription visible="yes"/> <briefdescription visible="no"/>
<includes visible="$SHOW_INCLUDE_FILES"/> <includes visible="$SHOW_INCLUDE_FILES"/>
<detaileddescription title=""/>
<inheritancegraph visible="$CLASS_GRAPH"/> <inheritancegraph visible="$CLASS_GRAPH"/>
<collaborationgraph visible="$COLLABORATION_GRAPH"/> <collaborationgraph visible="$COLLABORATION_GRAPH"/>
<memberdecl> <memberdecl>
@ -76,7 +77,6 @@
<friends title=""/> <friends title=""/>
<membergroups visible="yes"/> <membergroups visible="yes"/>
</memberdecl> </memberdecl>
<detaileddescription title=""/>
<memberdef> <memberdef>
<inlineclasses title=""/> <inlineclasses title=""/>
<typedefs title=""/> <typedefs title=""/>

8
doc/classes/QskControl.dox
View File

@ -1,5 +1,5 @@
/*! /*!
\headerfile QskControl.h \class QskControl QskControl.h
\brief Base class of all Qsk controls \brief Base class of all Qsk controls
@ -31,9 +31,3 @@
- QEvent::ContentsRectChange - QEvent::ContentsRectChange
- QEvent::LayoutRequest - QEvent::LayoutRequest
*/ */
class QskControl
{
public:
};

9
doc/classes/QskGraphic.dox
View File

@ -1,5 +1,5 @@
/*! /*!
\headerfile QskGraphic.h \class QskGraphic QskGraphic.h
\brief A paint device for scalable graphics \brief A paint device for scalable graphics
QskGraphic is the representation of a graphic that is tailored for QskGraphic is the representation of a graphic that is tailored for
@ -37,11 +37,4 @@
of the painter path ( the peak of a triangle is different than the flat side ) 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 scaling with a fixed aspect ratio always needs to be calculated from the
control point rectangle. control point rectangle.
\sa QskGraphicIO, QskPainterCommand
*/ */
class QskGraphic
{
public:
};

101
doc/classes/QskIndexedLayoutBox.dox
View File

@ -1,13 +1,10 @@
/*! /*!
\headerfile QskIndexedLayoutBox.h \class QskIndexedLayoutBox QskIndexedLayoutBox.h
\brief Base class of layouts with index ordered elements \brief Base class of layouts with index ordered elements
*/ */
class QskIndexedLayoutBox
{
public:
/*! /*!
\property bool autoAddChildren \property bool QskIndexedLayoutBox::autoAddChildren
\brief Flag controlling whether to automatically append children to the layout. \brief Flag controlling whether to automatically append children to the layout.
@ -21,7 +18,7 @@ class QskIndexedLayoutBox
*/ */
/*! /*!
\fn QskIndexedLayoutBox( QQuickItem * parent ) \fn QskIndexedLayoutBox::QskIndexedLayoutBox( QQuickItem* )
\brief Constructor \brief Constructor
@ -31,100 +28,19 @@ class QskIndexedLayoutBox
*/ */
/*! /*!
\fn ~QskIndexedLayoutBox() \fn QskIndexedLayoutBox::~QskIndexedLayoutBox()
\brief Destructor \brief Destructor
*/ */
/*! /*!
\fn void addItem( QQuickItem * item, Qt::Alignment alignment ) \fn void QskIndexedLayoutBox::autoAddChildrenChanged()
\brief Insert an item at the end
The geometries of items being inserted be controlled by the layout.
\param item Item to be inserted
\param alignment Flags to control how to align a non expandable element
inside of the available space.
\sa insertItem()
\sa QskLayout::itemAtIndex()
*/
/*!
\fn void insertItem( int index, QQuickItem* item,
Qt::Alignment alignment = Qt::Alignment() );
\brief Insert an item
The geometries of items being inserted be controlled by the layout.
\param index Position, where to insert the item. If index is < 0
or beyond QskLayout::itemCount() the item will be appended.
\param item Item to be inserted
\param alignment Flags to control how to align a non expandable element
inside of the available space.
\sa addItem(), QskLayout::itemAtIndex()
*/
/*!
\fn void setAlignment( int index, Qt::Alignment alignment );
\brief Modify the alignment of a layout element
\param index Position of the inserted element
\param alignment Flags to control how to align a non expandable element
inside of the available space
\note The alignment has only an effect, when the item can't be extended
to fill the cell geometry.
\sa alignment()
*/
/*!
\fn Qt::Alignment alignment( int index ) const;
\param index Position of the inserted element
\return Flags to control how to align a non expandable element
inside of the available space
\sa setAlignment()
*/
/*!
\fn void setAlignment( const QQuickItem * item, Qt::Alignment alignment );
\brief Modify the alignment of a layout element
\param item Inserted item
\param alignment Flags to control how to align a non expandable element
inside of the available space
\note The alignment has only an effect, when the item can't be extended
to fill the cell geometry.
\sa alignment()
*/
/*!
\fn Qt::Alignment alignment( const QQuickItem * item ) const;
\param item Inserted item
\return Flags to control how to align a non expandable element
inside of the available space
\sa setAlignment()
*/
/*!
\fn void autoAddChildrenChanged()
The autoAddChildren property has changed The autoAddChildren property has changed
\sa setAutoAddChildren(), autoAddChildren() \sa setAutoAddChildren(), autoAddChildren()
*/ */
/*! /*!
\fn void setAutoAddChildren( bool on ) \fn void QskIndexedLayoutBox::setAutoAddChildren( bool on )
\brief En/Disable auto appending of children \brief En/Disable auto appending of children
@ -139,16 +55,15 @@ class QskIndexedLayoutBox
*/ */
/*! /*!
\fn bool autoAddChildren() const \fn bool QskIndexedLayoutBox::autoAddChildren() const
\return Value of the \ref autoAddChildren property \return Value of the \ref autoAddChildren property
*/ */
/*! /*!
\fn void itemChange( QQQuickItem *::ItemChange, const QQQuickItem *::ItemChangeData & ) \fn void QskIndexedLayoutBox::itemChange( QQQuickItem *::ItemChange, const QQQuickItem *::ItemChangeData & )
Checking ItemChildAddedChange/ItemChildRemovedChange changes to Checking ItemChildAddedChange/ItemChildRemovedChange changes to
implement the \ref autoAddChildren mode implement the \ref autoAddChildren mode
\sa autoAddChildren \sa autoAddChildren
*/ */
};

206
doc/classes/QskLinearBox.dox
View File

@ -1,5 +1,5 @@
/*! /*!
\headerfile QskLinearBox.h \class QskLinearBox QskLinearBox.h
\brief Layout stringing items in rows and columns \brief Layout stringing items in rows and columns
@ -27,12 +27,8 @@
\sa QskGridBox, QskStackBox \sa QskGridBox, QskStackBox
*/ */
class QskLinearBox
{
public:
/*! /*!
\property Qt::Orientation orientation \property Qt::Orientation QskLinearBox::orientation
\brief Direction of flow for laying out the items \brief Direction of flow for laying out the items
@ -50,7 +46,7 @@ class QskLinearBox
*/ */
/*! /*!
\property uint dimension \property uint QskLinearBox::dimension
\brief Upper limit for the number of elements in a row or column \brief Upper limit for the number of elements in a row or column
@ -66,7 +62,7 @@ class QskLinearBox
*/ */
/*! /*!
\property qreal spacing \property qreal QskLinearBox::spacing
\brief Global layout spacing \brief Global layout spacing
@ -83,7 +79,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn QskLinearBox( QQuickItem * parent ); \fn QskLinearBox::QskLinearBox( QQuickItem* );
\brief Create a row layout \brief Create a row layout
@ -95,7 +91,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn QskLinearBox( Qt::Orientation orientation, QQuickItem * parent ); \fn QskLinearBox::QskLinearBox( Qt::Orientation orientation, QQuickItem * parent );
\brief Create a row or column layout \brief Create a row or column layout
@ -108,8 +104,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn QskLinearBox( Qt::Orientation orientation, \fn QskLinearBox::QskLinearBox( Qt::Orientation, uint, QQuickItem* );
int dimension, QQuickItem * parent );
\brief Constructor \brief Constructor
@ -123,13 +118,13 @@ class QskLinearBox
*/ */
/*! /*!
\fn ~QskLinearBox(); \fn QskLinearBox::~QskLinearBox();
Destructor Destructor
*/ */
/*! /*!
\fn void setOrientation( Qt::Orientation orientation ); \fn void QskLinearBox::setOrientation( Qt::Orientation orientation );
\brief Set the orientation of the layout \brief Set the orientation of the layout
\param orientation Qt::Vertical or Qt::Horizontal \param orientation Qt::Vertical or Qt::Horizontal
@ -137,12 +132,12 @@ class QskLinearBox
*/ */
/*! /*!
\fn Qt::Orientation orientation(void) const; \fn Qt::Orientation QskLinearBox::orientation() const;
\return Value of the \ref orientation property \return Value of the \ref orientation property
*/ */
/*! /*!
\fn void transpose() \fn void QskLinearBox::transpose()
\brief Invert the orientation of the layout \brief Invert the orientation of the layout
@ -151,14 +146,14 @@ class QskLinearBox
*/ */
/*! /*!
\fn void orientationChanged() \fn void QskLinearBox::orientationChanged()
The orientation of the layout has changed The orientation of the layout has changed
\sa orientation \sa orientation
*/ */
/*! /*!
\fn void setDimension( uint dimension ); \fn void QskLinearBox::setDimension( uint dimension );
\brief Set the dimension of the layout \brief Set the dimension of the layout
@ -169,26 +164,26 @@ class QskLinearBox
*/ */
/*! /*!
\fn uint dimension(void); \fn uint QskLinearBox::dimension(void);
\return Value of the \ref dimension property const \return Value of the \ref dimension property const
*/ */
/*! /*!
\fn void dimensionChanged() \fn void QskLinearBox::dimensionChanged()
The dimension of the layout has changed The dimension of the layout has changed
\sa setDimension(), dimension() \sa setDimension(), dimension()
*/ */
/*! /*!
\fn void spacingChanged() \fn void QskLinearBox::spacingChanged()
The spacing of the layout has changed The spacing of the layout has changed
\sa setSpacing(), spacing(), setRowSpacing(), setColumnSpacing() \sa setSpacing(), spacing(), setRowSpacing(), setColumnSpacing()
*/ */
/*! /*!
\fn void setSpacing( qreal spacing ) \fn void QskLinearBox::setSpacing( qreal spacing )
\brief Set the global spacing of the layout \brief Set the global spacing of the layout
\param spacing Distance between each cell and row \param spacing Distance between each cell and row
@ -196,20 +191,20 @@ class QskLinearBox
*/ */
/*! /*!
\fn void resetSpacing() \fn void QskLinearBox::resetSpacing()
\brief Reset the global spacing to its initial value \brief Reset the global spacing to its initial value
\sa spacing \sa spacing
*/ */
/*! /*!
\fn qreal spacing(void) const \fn qreal QskLinearBox::spacing(void) const
\return Value of the \ref spacing property \return Value of the \ref spacing property
*/ */
/*! /*!
\fn void addSpacer( qreal spacing, int stretchFactor ) \fn void QskLinearBox::addSpacer( qreal spacing, int stretchFactor )
\brief Append a spacer to the layout \brief Append a spacer to the layout
@ -223,7 +218,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn void insertSpacer( int index, qreal spacing, int stretchFactor ) \fn void QskLinearBox::insertSpacer( int index, qreal spacing, int stretchFactor )
\brief Insert a spacer at a specific position \brief Insert a spacer at a specific position
@ -248,7 +243,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn void addStretch( int stretchFactor ) \fn void QskLinearBox::addStretch( int stretchFactor )
\brief Append a stretch to the layout \brief Append a stretch to the layout
@ -262,7 +257,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn void insertStretch( int index, int stretchFactor ) \fn void QskLinearBox::insertStretch( int index, int stretchFactor )
\brief Insert a stretch at a specific position \brief Insert a stretch at a specific position
@ -279,7 +274,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn void setStretchFactor( int index, int stretchFactor ) \fn void QskLinearBox::setStretchFactor( int index, int stretchFactor )
\brief Modify the stretch factor of a layout element \brief Modify the stretch factor of a layout element
@ -292,7 +287,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn int stretchFactor( int index ) const \fn int QskLinearBox::stretchFactor( int index ) const
\param index Position of the inserted element \param index Position of the inserted element
\return Stretch factor of a layout element \return Stretch factor of a layout element
@ -301,7 +296,7 @@ class QskLinearBox
*/ */
/*! /*!
\fn void setStretchFactor( const QQuickItem * item, int stretchFactor ) \fn void QskLinearBox::setStretchFactor( const QQuickItem * item, int stretchFactor )
\brief Modify the stretch factor of an inserted item \brief Modify the stretch factor of an inserted item
@ -314,157 +309,10 @@ class QskLinearBox
*/ */
/*! /*!
\fn int stretchFactor( const QQuickItem * item ) const \fn int QskLinearBox::stretchFactor( const QQuickItem * item ) const
\param item Inserted item \param item Inserted item
\return Stretch factor of a layout element \return Stretch factor of a layout element
\sa setStretchFactor() \sa setStretchFactor()
*/ */
/*!
\fn void setRetainSizeWhenHidden( int index, bool on )
\brief Modify the effect of an element on the layout, when being hidden
The retainSizeWhenHidden() flag controls how the layout will treat
an item, when being explicitely hidden.
When being enabled the corresponding cell will be resized like in the visible
state ( showing a blank space ). Otherwise the cell will disappear and all
following cells will be shifted down.
\param index Position of the inserted element
\param on En/Disable the retainSizeWhenHidden() flag
\sa QQuickItem::isVisible()
*/
/*!
\fn bool retainSizeWhenHidden( int index ) const
\param index Position of the inserted element
\return True, when the retainSizeWhenHidden() flag is enabled
*/
/*!
\fn void setRetainSizeWhenHidden( const QQuickItem * item, bool on )
\brief Modify the effect of an element on the layout, when being hidden
The retainSizeWhenHidden() flag controls how the layout will treat
an item, when being explicitely hidden.
When being enabled the corresponding cell will be resized like in the visible
state ( showing a blank space ). Otherwise the cell will disappear and all
following cells will be shifted down.
\param item Inserted item
\param on En/Disable the retainSizeWhenHidden() flag
\sa QQuickItem::isVisible()
*/
/*!
\fn bool retainSizeWhenHidden( const QQuickItem * item ) const
\param item Inserted item
\return True, when the retainSizeWhenHidden() flag is enabled
*/
/*!
\fn void setRowSpacing( int row, qreal spacing )
\brief Add an extra spacing at the end of a row
\param row Row index
\param spacing Extra space at the end of a row
\note The spacing has no effect for the last row
\sa rowSpacing(), setColumnSpacing(), spacing
*/
/*!
\fn qreal rowSpacing( int row ) const
\param row Row index
\return Extra space at the end of a row
\sa setRowSpacing(), spacing
*/
/*!
\fn void setColumnSpacing( int column, qreal spacing )
\brief Add an extra spacing at the end of a column
\param column Column index
\param spacing Extra space at the end of a column
\note The spacing has no effect for the last column
\sa columnSpacing(), setRowSpacing(), spacing
*/
/*!
\fn qreal columnSpacing( int column ) const
\param column Column index
\return Extra space at the end of a column
\sa setColumnSpacing(), rowSpacing(), spacing
*/
/*!
\fn void setRowStretchFactor( int row, int stretchFactor )
\brief Modify the stretch factor of a row
\param row Index of the row
\param stretchFactor A value between [0..10].
The ratio of the stretch factors of expandable
candidates decides about how to distribute extra space.
\note Having a stretch factor for the row and for an item of the same row
might lead to confusing results
\sa rowStretchFactor(), stretchFactor()
*/
/*!
\fn int rowStretchFactor( int row ) const
\param row Index of the row
\return Stretch factor of the row
\sa setRowStretchFactor(), colulnStretchFactor()
*/
/*!
\fn void setColumnStretchFactor( int column, int stretchFactor )
\brief Modify the stretch factor of a column
\param column Index of the column
\param stretchFactor A value between [0..10].
The ratio of the stretch factors of expandable
candidates decides about how to distribute extra space.
\note Having a stretch factor for the column and for an item of the same column
might lead to confusing results
\sa rowStretchFactor(), stretchFactor()
*/
/*!
\fn int QskLinearBox::columnStretchFactor( int column ) const
\param column Index of the column
\return Stretch factor of the column
\sa setColumnStretchFactor(), rowStretchFactor()
*/
/*!
\fn QSizeF QskLinearBox::contentsSizeHint() const
\return Preferred size without the contents margins
\note The calculation of the hint depends ob the hints
of the items inserted to the layout.
*/
};

22
doc/classes/QskQuickItem.dox
View File

@ -1,18 +1,13 @@
/*! /*!
\headerfile QskQuickItem.h \class QskQuickItem QskQuickItem.h
\brief what a quick item
*/ */
class QskQuickItem
{
public:
/*! /*!
\enum Flag \enum QskQuickItem::Flag
QQuick classes have a tendency to update items too early Qt/Quick classes have a tendency to update items too early
and too often. To avoid processing of unwanted operations and too often. To avoid processing of unwanted operations
QskControl implements a couple of modifications, that QskQuickItem implements a couple of modifications, that
can be en/disabled individually. can be en/disabled individually.
The default setting enables all attributes. The default setting enables all attributes.
@ -52,16 +47,19 @@ class QskQuickItem
Always fill the background of thecontrol with a random color. Always fill the background of thecontrol with a random color.
\note This flag is useful when analyzing layouts. \note This flag is useful when analyzing layouts.
\sa controlFlags(), setControlFlags(), resetControlFlags()
testControlFlag(), setControlFlag(), resetControlFlag()
*/ */
/*! /*!
\fn void setControlFlag( Flag, bool on = true ); \fn void QskQuickItem::setControlFlag( Flag, bool on = true );
*/ */
/*! /*!
\fn void resetControlFlag( Flag ); \fn void QskQuickItem::resetControlFlag( Flag );
*/ */
/*! /*!
\fn bool testControlFlag( Flag ) const; \fn bool QskQuickItem::testControlFlag( Flag ) const;
*/ */

7
doc/classes/QskSeparator.dox
View File

@ -7,7 +7,7 @@
It can be used in horizontal or vertical direction by setting the It can be used in horizontal or vertical direction by setting the
orientation property to Qt::Vertical or Qt::Horizontal, respectively. orientation property to Qt::Vertical or Qt::Horizontal, respectively.
\subcontrols Panel \subcontrols QskSeparator::Panel
\skinlet QskSeparatorSkinlet \skinlet QskSeparatorSkinlet
*/ */
@ -22,6 +22,11 @@
\accessors orientation(), setOrientation(), orientationChanged() \accessors orientation(), setOrientation(), orientationChanged()
*/ */
/*!
\var QskSeparator::Panel
\sa QskSeparatorSkinlet
*/
/*! /*!
\fn QskSeparator::QskSeparator( QQuickItem* ) \fn QskSeparator::QskSeparator( QQuickItem* )

17
doc/classes/QskSetup.dox
View File

@ -1,20 +1,16 @@
/*! /*!
\headerfile QskSetup.h \class QskSetup QskSetup.h
\brief Singleton maintaining the global settings of an application using Qsk controls \brief Singleton maintaining the global settings of an application using Qsk controls
*/ */
class QskSetup
{
public:
/*! /*!
\property QskSkin* skin \property QskSkin* QskSetup::skin
\accessors skin(), setSkin(), skinChanged() \accessors skin(), setSkin(), skinChanged()
*/ */
/*! /*!
\enum Flag \enum QskSetup::Flag
\var DeferredUpdate \var DeferredUpdate
\var DeferredPolish \var DeferredPolish
@ -25,14 +21,13 @@ class QskSetup
*/ */
/*! /*!
\fn void setSkin( QskSkin* ); \fn void QskSetup::setSkin( QskSkin* );
*/ */
/*! /*!
\fn QskSkin* skin(); \fn QskSkin* QskSetup::skin();
*/ */
/*! /*!
\fn void skinChanged( QskSkin* ); \fn void QskSetup::skinChanged( QskSkin* );
*/ */
};

13
doc/classes/QskSkinlet.dox
View File

@ -1,17 +1,10 @@
/*! /*!
\headerfile QskSkinlet.h \class QskSkinlet QskSkinlet.h
\brief Describes the rendering interface of a QskControl. Change the \brief Describes the rendering interface of a QskControl. Change the
skinlet to change the appearance of the control using the low-level scene skinlet to change the appearance of the control using the low-level scene
graph API. graph API.
\sa QskControl::setSkinlet() \sa QskSkinnable::effectiveSkinlet(), QskSkinnable::setSkinlet(),
\sa QskSkin QskSkin::declareSkinlet(), QskSkin::skinlet()
\sa setMetric()
\sa setColor()
*/ */
class QskSkinlet
{
public:
};

57
doc/classes/QskSkinnable.dox
View File

@ -1,48 +1,9 @@
/*! /*!
\headerfile QskControl.h \class QskSkinnable QskSkinnable.h
\brief Base class of all Qsk controls
QskControl is the base class for most visible Qsk controls.
It re-establishes several concepts known from QWidget, that got lost
with QQuickItem:
- contentsRect()
- autoFillBackground()
- support of layout rules: sizeHint(), sizePolicy()
- font, palette, locale and their propagation on the item tree
Even if QQuickItem is part of the public C++ API it has obviously been
designed for implementing custom items, but not for using them in C++
code. To support this use case a lot of trivial methods have been added.
For some reason the QQuick classes introduced proprietory notfier hooks
instead of using the well established and powerful concept of events.
QskControl tries to revert this decision by mapping notifications
to events, when possible.
The following events are currently implemented:
- QEvent::FontChange
- QEvent::PaletteChange
- QEvent::LocaleChange
- QEvent::LayoutDirectionChange
- QEvent::ContentsRectChange
- QEvent::LayoutRequest
*/
class QskControl
{
public:
/*!
\fn float metric( QskAspect::Aspect aspect ) const
A convenience method equivalent to skinHint( aspect ).metric. The
QskSkinHint::TypeMask is set to QskSkinHint::Metric.
*/ */
/*! /*!
\fn void setSkinlet( QskSkinlet* skinlet ) \fn void QskSkinnable::setSkinlet( QskSkinlet* )
Allows overriding the QskControl::Skin used by this control to render its Allows overriding the QskControl::Skin used by this control to render its
contents. contents.
@ -50,14 +11,14 @@ public:
*/ */
/*! /*!
\fn const QskSkinlet* skinlet() const; \fn const QskSkinlet* QskSkinnable::skinlet() const;
\return Skinlet assigned by setSkinlet(). \return Skinlet assigned by setSkinlet().
\sa effectiveSkinlet() \sa effectiveSkinlet()
*/ */
/*! /*!
\fn QskSkinHint skinHint( QskAspect::Aspect aspect ) const \fn QVariant QskSkinnable::effectiveHint( QskAspect::Aspect, QskSkinHintStatus* ) const
Returns the QskSkinHint value for a QskAspect::Aspect. If none is set for Returns the QskSkinHint value for a QskAspect::Aspect. If none is set for
this control, the value for QskSkin::skinHint() is returned. this control, the value for QskSkin::skinHint() is returned.
@ -70,7 +31,14 @@ public:
*/ */
/*! /*!
\fn void updateNode( QSGNode* parentNode ) \fn qreal QskSkinnable::metric( QskAspect::Aspect, QskSkinHintStatus* ) const
A convenience method equivalent to skinHint( aspect ).metric. The
QskSkinHint::TypeMask is set to QskSkinHint::Metric.
*/
/*!
\fn void QskSkinnable::updateNode( QSGNode* )
This method replaces the QQuickItem::updatePaintNode method as the This method replaces the QQuickItem::updatePaintNode method as the
preferred paint method to override when subclassing QskControl. This allows preferred paint method to override when subclassing QskControl. This allows
@ -82,4 +50,3 @@ public:
\param parentNode The parent of the nodes to be added in this method. \param parentNode The parent of the nodes to be added in this method.
\return The parent node. \return The parent node.
*/ */
};

1
doc/qskmodules.dox
View File

@ -155,7 +155,6 @@
\class QskMessageWindow \class QskMessageWindow
\class QskSelectionSubWindow \class QskSelectionSubWindow
\class QskSelectionWindow \class QskSelectionWindow
\class QskSeparator
\class QskSimpleListBox \class QskSimpleListBox
\} \}