Merge "Change ItemFactory destructor to be not pure virtual" into tizen
[platform/core/uifw/dali-toolkit.git] / docs / content / programming-guide / custom-actor.h
index 147ad73..808bfca 100644 (file)
@@ -2,7 +2,7 @@
  * The Dali::CustomActor is used as a base class for UI controls.  It is a proxy object to enable derived classes access
  * to a subset of the methods defined in the internal Actor class.
  *
- * Classes deriving from Custom Actor should follow the same design principle as the rest of the Dali API.
+ * Classes deriving from Custom Actor should follow the same handle - body design principle as the rest of the Dali API.
  *
  * One class of the new UI control should inherit from Dali::CustomActor, while a second should inherit
  * Dali::CustomActorImpl.  This implementation class contains a number of pure virtual methods that enable the new UI
  *
  * In the New() method for the myNewButton class, the user should then create a new instance of the myNewButtonImpl class
  * and pass this to the constructor of the myNewButton object.  Internally the connection will be made
- * between the new widget actor and Dali, thus allowing messages such as OnSizeSet to be received by the new actor.
+ * between the new widget actor and Dali, thus allowing messages such as OnPropertySet to be received by the new actor.
  *
  * It is the responsibility of the implementation of the new UI control to implement the method bodies for the inherited
  * pure virtual methods from Dali::CustomActorImpl.  Obviously the application won't compile if the methods are not
  * overidden, but the user does not need to fill in the code for methods they don't want or need to use.
  *
- * The following code shows the static New() method from the implementation part of the TextView UI control:
- * \code
- * Dali::Toolkit::TextView TextView::New()
- * {
- *   // Create the implementation, temporarily owned on stack
- *   boost::intrusive_ptr< TextView > textView = new TextView;
- *
- *   // Pass ownership to CustomActor
- *   Dali::Toolkit::TextView handle( *textView );
- *
- *   // Second-phase init of the implementation
- *   // This can only be done after the CustomActor connection has been made...
- *   textView->Initialize();
- *
- *   return handle;
- * }
- * \endcode
- *
  * After the implementation object is created it is passed back to the basic Text View through the constructor,the
  * constructor uses this passed in object to initialise the internal implementation objects.
  *
  * handler methods, and do all the rest of their widget processing the the main myNewButton class.  Access to the
  * implementation class can be gained using the GetImpl(*this) method.  For example:
  *
- * \code
- * void TextView::SetFont(const Font newFont)
- * {
- *  GetImpl(*this).SetFont(newFont);
- * }
- * \endcode
  */