/xbmc/visualizations/Vortex/angelscript/docs/manual/doc_script_class_prop.html

http://github.com/xbmc/xbmc · HTML · 51 lines · 50 code · 0 blank · 1 comment · 0 complexity · 24f11b503d7ddfee1c0b8517aaa7f133 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
    3. 

  3. <title>AngelScript: Property accessors</title>
    4. 

  4. <link href="tabs.css" rel="stylesheet" type="text/css">
    5. 

  5. <link href="doxygen.css" rel="stylesheet" type="text/css">
    6. 

  6. </head><body>
    7. 

  7. <!-- Generated by Doxygen 1.5.9 -->
    8. 

  8. <div class="contents">
    9. 

  9. <h1><a class="anchor" name="doc_script_class_prop">Property accessors </a></h1>Many times when working with class properties it is necessary to make sure specific logic is followed when accessing them. An example would be to always send a notification when a property is modified, or computing the value of the property from other properties. By implementing property accessor methods for the properties this can be implemented by the class itself, making it easier for the one who accesses the properties.<p>
    10. 

  10. In AngelScript property accessors are implemented as ordinary class methods with the prefixes <code>get_</code> and <code>set_</code>.<p>
    11. 

  11. <pre>
    12. 

  12.   // The class declaration with property accessors
    13. 

  13.   class MyObj
    14. 

  14.   {
    15. 

  15.     int get_prop() const
    16. 

  16.     {
    17. 

  17.       // The actual value of the property could be stored
    18. 

  18.       // somewhere else, or even computed at access time
    19. 

  19.       return realProp;
    20. 

  20.     }</pre><p>
    21. 

  21. <pre>    void set_prop(int val)
    22. 

  22.     {
    23. 

  23.       // Here we can do extra logic, e.g. make sure 
    24. 

  24.       // the value is within the proper range
    25. 

  25.       if( val &gt; 1000 ) val = 1000;
    26. 

  26.       if( val &lt; 0 ) val = 0;</pre><p>
    27. 

  27. <pre>      realProp = val;
    28. 

  28.     }</pre><p>
    29. 

  29. <pre>    // The caller should use the property accessors
    30. 

  30.     // 'prop' to access this property
    31. 

  31.     int realProp;
    32. 

  32.   }</pre><p>
    33. 

  33. <pre>  // An example for how to access the property through the accessors
    34. 

  34.   void Func()
    35. 

  35.   {
    36. 

  36.     MyObj obj;</pre><p>
    37. 

  37. <pre>    // Set the property value just like a normal property.
    38. 

  38.     // The compiler will convert this to a call to set_prop(10000).
    39. 

  39.     obj.prop = 10000;</pre><p>
    40. 

  40. <pre>    // Get the property value just a like a normal property.
    41. 

  41.     // The compiler will convert this to a call to get_prop().
    42. 

  42.     assert( obj.prop == 1000 );
    43. 

  43.   }
    44. 

  44. </pre><p>
    45. 

  45. When implementing the property accessors you must make sure the return type of the get accessor and the parameter type of the set accessor match, otherwise the compiler will not know which is the correct type to use.<p>
    46. 

  46. You can also leave out either the get or set accessor. If you leave out the set accessor, then the property will be read-only. If you leave out the get accessor, then the property will be write-only. </div>
    47. 

  47. <hr size="1"><address style="text-align: right;"><small>Generated on Wed Dec 16 19:34:51 2009 for AngelScript by&nbsp;
    48. 

  48. <a href="http://www.doxygen.org/index.html">
    49. 

  49. <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
    50. 

  50. </body>
    51. 

  51. </html>
    52.