QskPlacementPolicy.dox added

doc/classes/QskPlacementPolicy.dox

@@ -0,0 +1,176 @@
+/*!
+    \class QskPlacementPolicy QskPlacementPolicy.h
+
+    \ingroup Framework
+
+	QskPlacementPolicy is a hint for layout code how to deal with
+	the geometry of an item when being visible or hidden.
+
+    \sa QskControl::placementPolicy(), qskPlacementPolicy()
+*/
+
+/*!
+    \enum QskPlacementPolicy::Policy
+
+	Hint for the layout code how to deal with the geometry of an
+	item. QskPlacementPolicy has two values one for the visible,
+	the other for the hidden state.
+
+    \var QskPlacementPolicy::Ignore
+
+         Ignore the item for all type of layout calculations.
+
+    \var QskPlacementPolicy::Reserve
+
+         Reseve space without giving the item its geometry.
+
+    \var QskPlacementPolicy::Adjust
+
+         Reserve space and adjust the geometry of the item
+
+	\note QskPlacementPolicy::Reserve as hiddenPolicy() is equivalent
+	      to what is offered by QSizePolicy::retainSizeWhenHidden().
+*/
+
+/*!
+    \property QskPlacementPolicy::Policy QskPlacementPolicy::visiblePolicy
+
+    \brief Policy for the item, when being visible ( to its parent )
+
+	- QskPlacementPolicy::Ignore
+
+      For situations where a parent takes care of the geometry for its children,
+      but exceptions need to be defined. F.e a focus indicator.
+
+	- QskPlacementPolicy::Reserve:
+
+	  There are not many relevant scenarios for this value. An
+	  example might be when an item is inside of a grid layout, where all the
+	  size hints should have an effect, but the final alignment of the item
+	  inside of the cell has to be done manually.
+
+	- QskPlacementPolicy::Adjust:
+
+      The default value
+
+    \accessors visiblePolicy(), setVisiblePolicy()
+	\sa hiddenPolicy, qskIsVisibleToParent()
+
+    \note QskPlacementPolicy::Ignore is stored in the transparentForPositioner
+	      bit in QQuickItem and might have an impact on Qt/Quick layout code.
+*/
+
+/*!
+    \property QskPlacementPolicy::Policy QskPlacementPolicy::hiddenPolicy
+    
+    \brief Policy for the item, when being hidden ( to its parent )
+    
+    - QskPlacementPolicy::Ignore
+    
+      The default value
+      
+    - QskPlacementPolicy::Reserve:
+
+      In combination with a visiblePolicy != QskPlacementPolicy::Ignore
+      the layout of the parent does not change, when the item is shown/hidden.
+      
+    - QskPlacementPolicy::Adjust:
+    
+      Sometimes an item wants to have its proper size even when being hidden.
+      
+    \accessors visiblePolicy(), setVisiblePolicy()
+    \sa qskIsVisibleToParent()
+    
+    \note QskPlacementPolicy::Ignore is stored in the transparentForPositioner
+          bit in QQuickItem and might have an impact on Qt/Quick layout code.
+*/
+
+/*!
+    \fn QskPlacementPolicy::QskPlacementPolicy()
+
+    visiblePolicy is set to QskPlacementPolicy::Adjust,
+	hiddenPolicy to QskPlacementPolicy::Ignore.
+*/
+
+/*!
+    \fn QskPlacementPolicy::QskPlacementPolicy( Policy policy )
+
+	visiblePolicy and hiddenPolicy are set to policy
+*/
+
+/*!
+    \fn QskPlacementPolicy::QskPlacementPolicy( Policy visiblePolicy, Policy hiddenPolicy )
+
+	Initialization from visiblePolicy and hiddenPolicy
+*/
+
+/*! 
+    \fn QskPlacementPolicy::QskPlacementPolicy( Qsk::Visibilities visiblities, Policy policy )
+
+	Initialize visiblePolicy and hiddenPolicy depending on visiblities
+*/
+
+/*
+    \fn QskPlacementPolicy::operator==( const QskPlacementPolicy& )
+
+    "Equal to" operator
+    \sa operator!=(), operator<()
+*/
+
+/*
+    \fn QskPlacementPolicy::operator!=( const QskPlacementPolicy& )
+
+	"Not equal to" operator
+    \sa operator==(), operator<()
+*/
+
+/*
+    \fn QskPlacementPolicy::setPolicy( Qsk::Visibilities, Policy )
+*/
+
+*/
+    \fn QskPlacementPolicy::policy( Qsk::Visibility )
+*/
+
+/*
+    \fn QskPlacementPolicy::isEffective()
+
+	\return true, when visiblePolicy or hiddenPolicy is not QskPlacementPolicy::Ignore
+	\sa isIgnoring()
+*/
+
+/*
+    \fn QskPlacementPolicy::isIgnoring( Qsk::Visibility )
+	\return true, when visiblePolicy and hiddenPolicy is QskPlacementPolicy::Ignore
+	\sa isEffective()
+*/
+
+/*
+    \fn QskPlacementPolicy::isAdjusting( Qsk::Visibility )
+
+	\return true, when QskPlacementPolicy::Adjust is set for the visibility
+*/
+
+/*
+    \fn QskPlacementPolicy::setVisiblePolicy( Policy )
+
+	\sa visiblePolicy(), setHiddenPolicy()
+*/
+
+/*
+    \fn QskPlacementPolicy::visiblePolicy()
+
+	\sa setVisiblePolicy(), hiddenPolicy()
+*/
+
+/*
+    \fn QskPlacementPolicy::setHiddenPolicy( Policy )
+
+	\sa hiddenPolicy(), setVisiblePolicy()
+*/
+
+/*
+    \fn QskPlacementPolicy::hiddenPolicy()
+
+	\sa setHiddenPolicy(), visiblePolicy()
+*/

doc/qskmodules.dox

@@ -5,7 +5,7 @@
     \defgroup Animation Animation
     \defgroup Themeing Themeing
     \defgroup Controls Controls
-    \defgroup container Container
+    \defgroup Container Container
     \defgroup Layouts Layouts
     \defgroup Dialogs Dialogs
     \defgroup Skinlets Skinlets