*/
namespace Dimension
{
- /**
- * @brief The type of Dimension
- * @SINCE_1_0.0
- */
enum Type
{
WIDTH = 0x1, ///< Width dimension @SINCE_1_0.0
ALL_DIMENSIONS = 0x3 ///< Mask to cover all flags @SINCE_1_0.0
};
- /**
- * @brief The number of dimensions
- * @SINCE_1_0.0
- */
enum Meta
{
DIMENSION_COUNT = 2 ///< Number of dimensions - update this if adding new dimension @SINCE_1_0.0
*/
namespace ResizePolicy
{
- /**
- * @brief The type of ResizePolicy
- * @SINCE_1_0.0
- */
enum Type
{
FIXED, ///< Size is fixed as set by SetSize @SINCE_1_0.0
*/
namespace SizeScalePolicy
{
- /**
- * @brief The type of SizeScalePolicy
- * @SINCE_1_0.0
- */
enum Type
{
USE_SIZE_SET, ///< Use the size that was set @SINCE_1_0.0
*/
namespace HorizontalAlignment
{
- /**
- * @brief The type of HorizontalAlignment
- * @SINCE_1_0.0
- */
enum Type
{
LEFT, ///< Align horizontally left @SINCE_1_0.0
*/
namespace VerticalAlignment
{
- /**
- * @brief The type of VerticalAlignment
- * @SINCE_1_0.0
- */
enum Type
{
TOP, ///< Align vertically top @SINCE_1_0.0
*/
namespace ClippingMode
{
- /**
- * @brief The type of ClippingMode
- * @SINCE_1_2_5
- */
enum Type
{
DISABLED, ///< This Actor will not clip its children. @SINCE_1_2_5
protected: // For derived classes
- /**
- * @brief Flags for the constructor
- * @SINCE_1_0.0
- */
+ // Flags for the constructor
enum ActorFlags
{
ACTOR_BEHAVIOUR_NONE = 0,
/**
* @brief @ return If the vector is empty
* @SINCE_1_0.0
- * @return true if the count of elements is empty
*/
bool Empty() const
{
/**
* @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] rhs Const reference to an IntrusivePtr
*/
IntrusivePtr( IntrusivePtr const& rhs ) : mPtr( rhs.mPtr )
{
*
* Use with care.
* @SINCE_1_0.0
- * @return Pointer to reference counted object
*/
T* Detach()
{
* @brief Returns an actor by index. An empty handle if the index is not valid.
*
* @SINCE_1_0.0
- * @param[in] index The attached actor's index
* @return The attached actor or an empty handle.
* @pre The gesture detector has been initialized.
*/
* @brief Returns the angle by index that this pan gesture detector emits a signal.
*
* @SINCE_1_0.0
- * @param[in] index The angle's index
* @return An angle threshold pair, or a zero valued angle pair when index is invalid.
* @pre The gesture detector has been initialized.
* @pre The index is less than GetAngleCount()
*
* @SINCE_1_1.37
* @param[in] other The TouchData to copy from.
- * @return A reference to this
*/
TouchData& operator=( const TouchData& other );
*/
namespace FittingMode
{
- /**
- * @brief The type of FittingMode
- * @SINCE_1_0.0
- */
enum Type
{
SHRINK_TO_FIT, ///< Fit full image inside desired width & height, potentially not @SINCE_1_0.0
*/
namespace SamplingMode
{
- /**
- * @brief The type of SamplingMode
- * @SINCE_1_0.0
- */
enum Type
{
BOX, ///< Iteratively box filter to generate an image of 1/2, 1/4, @SINCE_1_0.0
/**
* @brief Query whether blending is required
* @SINCE_1_0.0
- * @return true if blending is required
*/
virtual bool RequiresBlending() const = 0;
{
public:
- /**
- * @brief Function to release the pixel buffer
- * @SINCE_1_1.43
- */
enum ReleaseFunction
{
FREE, ///< Use free function to release the pixel buffer @SINCE_1_1.43
* @param[in] height Buffer height in pixels
* @param[in] pixelFormat The pixel format
* @param[in] releaseFunction The function used to release the memory.
- * @return A handle to the PixelData
*/
static PixelData New( unsigned char* buffer,
unsigned int bufferSize,
/**
* @brief Negate the radian
* @SINCE_1_0.0
- * @param[in] in Radian to negate
* @return The negative angle
*/
inline Radian operator-( Radian in )
/**
* @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] rhs Handle to an object
- * @return A reference to this
*/
Uint16Pair& operator=( const Uint16Pair& rhs )
{
* @brief Assigns a given value to the Any type.
*
* @SINCE_1_0.0
- * @param[in] value The given value
- * @return A reference to this
+ * @param[in] value The given value.
* @note If the types are different, then the current container will be re-created.
*
*/
*
* @SINCE_1_0.0
* @param [in] any Any to be assigned which contains a value of identical type to current contents.
- * @return A reference to this
* @exception DaliException If parameter any is of a different type.
*
*/
* @brief Returns the type info for the Handle.
*
* @SINCE_1_0.0
- * @param[in] info The type information
- * @return The type info
+ * @return The type info.
*/
bool GetTypeInfo(Dali::TypeInfo& info) const;
/**
* @brief Equality operator
* @SINCE_1_0.0
- * @param[in] lhs A reference to compare
- * @param[in] rhs A reference to compare to
- * @return true if the handle handles point to the same Dali resource, or if both are NULL
*/
template <typename T>
inline bool operator==(const BaseHandle& lhs, const T& rhs)
/**
* @brief Equality operator
* @SINCE_1_0.0
- * @param[in] lhs A reference to compare
- * @param[in] rhs A reference to compare to
- * @return true if the handle handles point to the different Dali resources
*/
template <typename T>
inline bool operator!=(const BaseHandle& lhs, const T& rhs)
/**
* @brief Less than operator
* @SINCE_1_0.0
- * @param[in] lhs A reference to compare
- * @param[in] rhs A reference to compare to
- * @return true if lhs less than rhs
*/
inline bool operator<(const BaseHandle& lhs, const BaseHandle& rhs)
{
public: // Not intended for application developers
/**
- * @brief Not intended for application developers.
- *
- * @SINCE_1_0.0
- * @param [in] connectionTracker A connection tracker which can be used to disconnect.
- * @param [in] signalName Name of the signal to connect to.
- * @param [in] functorDelegate A newly allocatated functor delegate (takes ownership).
- * @return True if the signal was available.
+ * @copydoc Dali::BaseHandle::DoConnectSignal
*/
bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
/**
* @brief Increase the capcity of the array.
* @SINCE_1_0.0
- * @param[in] size The size to reserve
*/
void Reserve( SizeType size );
/**
* @brief Resize to size.
* @SINCE_1_0.0
- * @param[in] size The size to resize
*/
void Resize( SizeType size );
* @brief Retrieve the arguments that this condition uses.
*
* @SINCE_1_0.0
- * @param[in] index The condition index to get the argument
* @return The arguments used for this condition
* @note The container will only be valid as long PropertyCondition is valid.
*/
* @brief Retrieve the value of the string-value pair at the specified position.
*
* @SINCE_1_0.0
- * @param[in] position The specified position
* @return A reference to the value at the specified position.
*
* @note Will assert if position >= Count()
* @brief Retrieve the key at the specified position.
*
* @SINCE_1_0.0
- * @param[in] position The specified position
* @return A const reference to the key at the specified position.
*
* @note Will assert if position >= Count()
* @brief Retrieve the key & the value at the specified position.
*
* @SINCE_1_0.0
- * @param[in] position The specified position
* @return A reference to the pair of key and value at the specified position.
*
* @note Will assert if position >= Count()
/**
* @brief Get the target handle that this notification is observing.
* @SINCE_1_0.0
- * @return The target handle
*/
Dali::Handle GetTarget() const;
* @brief Get type names by index.
*
* @SINCE_1_0.0
- * @param[in] index The index to get the type name
* @return The type name or an empty string when index is not valid
*/
std::string GetTypeName(size_t index) const;
/**
* @brief If the refresh rate is REFRESH_ONCE, connect to this signal to be notified when a RenderTask has finished.
* @SINCE_1_0.0
- * @return The signal to connect to
*/
RenderTaskSignalType& FinishedSignal();
*/
struct Attachment
{
- /**
- * @brief The bit-mask value
- * @SINCE_1_1.45
- */
enum Mask
{
NONE = 0, ///< No attachments are created initially @SINCE_1_1.45
* @SINCE_1_1.43
* @param[in] geometry Geometry to be used by this renderer
* @param[in] shader Shader to be used by this renderer
- * @return A handle to the Renderer
*/
static Renderer New( Geometry& geometry, Shader& shader );
* @brief Creates a new Sampler object
*
* @SINCE_1_1.43
- * @return A handle to the Sampler
*/
static Sampler New();
* @brief Set the wrap modes for this sampler
*
* @SINCE_1_1.43
- * @param[in] uWrap Wrap mode for u coordinates
- * @param[in] vWrap Wrap mode for v coordinates
+ * param[in] uWrap Wrap mode for u coordinates
+ * param[in] vWrap Wrap mode for v coordinates
*/
void SetWrapMode( WrapMode::Type uWrap, WrapMode::Type vWrap );
* @brief Set the wrap modes for this sampler
*
* @SINCE_1_1.43
- * @param[in] rWrap Wrap mode for the z direction
- * @param[in] sWrap Wrap mode for the x direction
- * @param[in] tWrap Wrap mode for the y direction
+ * param[in] rWrap Wrap mode for the z direction
+ * param[in] sWrap Wrap mode for the x direction
+ * param[in] tWrap Wrap mode for the y direction
*/
void SetWrapMode( WrapMode::Type rWrap, WrapMode::Type sWrap, WrapMode::Type tWrap );
*/
struct Hint
{
- /**
- * @brief Hint value
- * @SINCE_1_1.45
- */
enum Value
{
NONE = 0x00, ///< No hints @SINCE_1_1.45
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
- * @return A reference to this
*/
TextureSet& operator=( const TextureSet& handle );
/**
* @brief Copy constructor operator not declared.
* @SINCE_1_0.0
- * @param[in] rhs Handle to an object
*/
CallbackBase( const CallbackBase& rhs );
/**
* @brief assignment operator not declared.
* @SINCE_1_0.0
- * @param[in] rhs Handle to an object
- * @return A reference to this
*/
const CallbackBase& operator=( const CallbackBase& rhs );
/**
* @brief Non-member equality operator
* @SINCE_1_0.0
- * @param[in] lhs A reference to compare
- * @param[in] rhs A reference to compare to
- * @return true if lhs is same as rhs
*/
bool operator==( const CallbackBase& lhs, const CallbackBase& rhs );
/**
* @brief Dispatcher to delete an object.
* @SINCE_1_0.0
- * @param[in] object An object to delete
*/
static void Delete( void* object )
{
/**
* @brief Dispatcher to delete an object
* @SINCE_1_0.0
- * @param[in] functorPtr A functor object to delete
*/
static void Delete( void* functorPtr )
{
projects / platform / core / uifw / dali-core.git / commitdiff