dalisounddir = ${dataReadOnlyDir}/toolkit/sounds/
dalisound_DATA = ${dali_toolkit_sound_files}
+package_doxy_dir = ../../../doc
+include ../../../doc/file.list
+
# The library
lib_LTLIBRARIES = libdali-toolkit.la
publicapifocusmanager_HEADERS = $(public_api_focus_manager_header_files)
publicapirenderingbackend_HEADERS = $(public_api_rendering_backend_header_files)
+# package doxygen file (contains doxygen grouping information)
+packagedoxydir = $(topleveldir)/doc
+packagedoxy_HEADERS = $(package_doxy_files)
# Note: If this tag is empty the current directory is searched.
INPUT = @DOXYGEN_DOCS_DIR@/content \
+ @prefix@/include/dali/doc/dali-core-doc.h \
+ @prefix@/include/dali/doc/dali-adaptor-doc.h \
+ ../../../../dali-toolkit/doc/dali-toolkit-doc.h \
+ @prefix@/include/dali \
../../../../dali-toolkit/dali-toolkit/public-api \
- ../../../automated-tests/README.md \
- @prefix@/include/dali
+ ../../../automated-tests/README.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
{
class AccessibilityManager;
}
+/**
+ * @addtogroup dali-toolkit-accessibility-manager
+ * @{
+ */
/**
* @brief Manages registration of actors in a accessibility focus chain and changing the
}; // class AccessibilityManager
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class Alignment;
}
+/**
+ * @addtogroup dali-toolkit-controls-alignment
+ * @{
+ */
/**
* @brief Alignment is a container which provides an easy way to align other actors inside its boundary.
explicit DALI_INTERNAL Alignment( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class Button;
}
+/**
+ * @addtogroup dali-toolkit-controls-buttons
+ * @{
+ */
/**
* @brief Button is a base class for different kind of buttons.
DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class CheckBoxButton;
}
+/**
+ * @addtogroup dali-toolkit-controls-buttons
+ * @{
+ */
/**
* CheckBoxButton provides a check box button which user can check or uncheck.
DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
class PushButton;
}
+/**
+ * @addtogroup dali-toolkit-controls-buttons
+ * @{
+ */
/**
* @brief A PushButton changes its appearance when is pressed and returns to its original when is released.
DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
class RadioButton;
}
+/**
+ * @addtogroup dali-toolkit-controls-buttons
+ * @{
+ */
/**
* @brief A RadioButton provides a radio button which two states \e selected or \e unselected.
DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls
+ * @{
+ */
+
enum ControlDepthIndexRanges
{
BACKGROUND_DEPTH_INDEX = static_cast<int>( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ),
DECORATION_DEPTH_INDEX = static_cast<int>( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f )
};
+/**
+ * @}
+ */
}
}
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls
+ * @{
+ */
+
class StyleManager;
namespace Internal
{
-
/**
* @brief This is the internal base class for all controls.
*
} // namespace Internal
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class Control;
}
+/**
+ * @addtogroup dali-toolkit-controls
+ * @{
+ */
/**
* @brief Control is the base class for all controls.
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
namespace Toolkit
{
-
/**
* @brief Creates a Dali::ImageActor with a solid color, optionally it creates a border.
*
* @return a handle to the new ImageActor
*/
DALI_IMPORT_API ImageActor CreateSolidColorActor( const Vector4& color, bool border = false, const Vector4& borderColor = Color::WHITE, const unsigned int borderSize = 1 );
-
} // namespace Toolkit
} // namespace Dali
class BloomView;
} // namespace Internal
+/**
+ * @addtogroup dali-toolkit-controls-gaussian-blur-view
+ * @{
+ */
/**
*
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class ImageView;
}
+/**
+ * @addtogroup dali-toolkit-controls-image-view
+ * @{
+ */
/**
*
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
class ScrollBar;
}
+/**
+ * @addtogroup dali-toolkit-controls-scroll-bar
+ * @{
+ */
/**
* ScrollBar is a UI component that can be linked to the scrollable objects
explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
-/**
- * @}
- */
#endif // __DALI_TOOLKIT_SCROLL_BAR_H__
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls-item-view
+ * @{
+ */
namespace DefaultItemLayout
{
} // namespace DefaultItemLayout
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls-item-view
+ * @{
+ */
/**
* @brief ItemFactory is for providing actors to ItemView.
}
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls-item-view
+ * @{
+ */
class ItemLayout;
Impl* mImpl;
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls-item-view
+ * @{
+ */
typedef unsigned int ItemId; ///< Unique identity for each item in the view.
class ItemView;
class ItemLayout;
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class ItemView;
}
+/**
+ * @addtogroup dali-toolkit-controls-item-view
+ * @{
+ */
class ItemFactory;
class ItemLayout;
explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls-scroll-view
+ * @{
+ */
// Constraints ////////////////////////////////////////////////////////////////////////////////////
*/
DALI_IMPORT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs );
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
class ScrollViewEffect;
class ScrollViewWobbleEffect;
}
+/**
+ * @addtogroup dali-toolkit-controls-scroll-view
+ * @{
+ */
class ScrollView;
class ScrollViewEffect;
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class ScrollViewPagePathEffect;
}
+/**
+ * @addtogroup dali-toolkit-controls-scroll-view
+ * @{
+ */
/**
* ScrollView Page Path Effect.
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class ScrollView;
}
+/**
+ * @addtogroup dali-toolkit-controls-scroll-view
+ * @{
+ */
/**
* @brief How axes/rotation or scale are clamped
explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class Scrollable;
}
+/**
+ * @addtogroup dali-toolkit-controls-scrollable
+ * @{
+ */
/**
* @brief Base class for derived Scrollables that contains actors that can be scrolled manually
explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class TableView;
}
+/**
+ * @addtogroup dali-toolkit-controls-table-view
+ * @{
+ */
/**
* @brief TableView is a layout container for aligning child actors in a grid like layout.
explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class TextField;
}
+/**
+ * @addtogroup dali-toolkit-controls-text-controls
+ * @{
+ */
/**
* @brief A control which provides a single-line editable text field.
explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class TextLabel;
}
+/**
+ * @addtogroup dali-toolkit-controls-text-controls
+ * @{
+ */
/**
* @brief A control which renders a short text string.
explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
namespace Dali
{
-
/**
* @brief DALi Toolkit namespace.
*/
namespace Toolkit
{
+/**
+ * @addtogroup dali-toolkit-controls
+ * @{
+ */
/**
* @brief Control Orientation namespace.
*/
DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation);
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
{
class KeyboardFocusManager;
}
+/**
+ * @addtogroup dali-toolkit-focus-manager
+ * @{
+ */
/**
* @brief Provides the functionality of handling keyboard navigation
}; // class KeyboardFocusManager
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
--- /dev/null
+#ifndef __DALI_TOOLKIT_DOC_H__
+#define __DALI_TOOLKIT_DOC_H__
+
+/**
+ * @defgroup dali DALi
+ * @ingroup CAPI_UI_FRAMEWORK
+ *
+ * @brief DALi is a cross-platform 3D UI Toolkit for embedded systems.
+ *
+ * @section dali-overview Overview
+ * DALi's 3D user interface engine enables you to create rich and high-performance
+ * UI applications. DALi is based on OpenGL ES 2.0, but provides a clean
+ * cross-platform C++ framework.
+ * This means that you can use high-level DALi APIs instead of accessing
+ * low-level OpenGL APIs directly.
+ * <ul>
+ * <li>DALi Core: This module provides scene graph-based rendering, animation, and event handling.</li>
+ * <li>DALi Adaptor: This module is a platform adaptation layer.</li>
+ * <li>DALi Toolkit: This module provides UI components and various effects on top of the dali-core.</li>
+ * </ul>
+ *
+ * @defgroup dali-toolkit DALi Toolkit
+ * @ingroup dali
+ *
+ * @brief This module provides UI components and various effects on top of the dali-core.
+ *
+ * @{
+ * @defgroup dali-toolkit-accessibility-manager Accessibility Manager
+ * @brief AccessibilityManager manages a accessibility focus chain.
+
+ * @defgroup dali-toolkit-controls Controls
+ * @brief Controls are interactive components for layouting the user interface.
+
+ * @{
+ * @defgroup dali-toolkit-controls-alignment Alignment
+ * @brief Alignment is a container which provides an easy way to align other actors inside its boundary.
+
+ * @defgroup dali-toolkit-controls-buttons Buttons
+ * @brief Button is a small object on UI that you can press.
+
+ * @defgroup dali-toolkit-controls-gaussian-blur-view Gaussian Blur View
+ * @brief GaussianBlurView provides a render process that blurs an image.
+
+ * @defgroup dali-toolkit-controls-image-view Image View
+ * @brief ImageView is a control displying an image.
+
+ * @defgroup dali-toolkit-controls-scroll-bar Scroll Bar
+ * @brief ScrollBar control.
+
+ * @defgroup dali-toolkit-controls-scrollable Scrollable
+ * @brief Scrollable container controls.
+
+ * @{
+ * @defgroup dali-toolkit-controls-item-view Item View
+ * @brief ItemView class is a scrollable container that can contain many items.
+
+ * @defgroup dali-toolkit-controls-scroll-view Scroll View
+ * @brief ScrollView class provides scrollable view which contains actors and can be scrolled automatically or manually by panning.
+
+ * @}
+ * @defgroup dali-toolkit-controls-table-view Table View
+ * @brief TableView class is a layout container for aligning child actors in a grid like layout.
+
+ * @defgroup dali-toolkit-controls-text-controls Text Controls
+ * @brief Controls for displaying text or text input.
+
+ * @}
+ * @defgroup dali-toolkit-focus-manager Focus Manager
+ * @brief Classes for handling keyboard navigation and maintaining the two dimensional keyboard focus chain.
+
+ * @}
+ */
+
+
+#endif /* __DALI_TOOLKIT_DOC_H__ */
--- /dev/null
+package_doxy_files = \
+ $(package_doxy_dir)/dali-toolkit-doc.h
+
projects / platform / core / uifw / dali-toolkit.git / commitdiff