{
/// <summary>
///
- /// Container is an abstract class to be inherited from by classes that desire to have Views
+ /// The Container is an abstract class to be inherited from by classes that desire to have views
/// added to them.
///
/// </summary>
/// <summary>
/// Adds a child view to this Container.
/// </summary>
- /// <pre>This Container(the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.</pre>
+ /// <pre>This Container (the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.</pre>
/// <post>The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed.</post>
- /// <remarks>If the child already has a parent, it will be removed from old parent and reparented to this view. This may change child's position, color, scale etc as it now inherits them from this view.</remarks>
- /// <param name="view">The child view to add</param>
+ /// <remarks>If the child already has a parent, it will be removed from the old parent and reparented to this view. This may change child's position, color, scale, etc. as it now inherits them from this view.</remarks>
+ /// <param name="view">The child view to add.</param>
public abstract void Add( View view );
/// <summary>
- /// Removes a child View from this View. If the view was not a child of this view, this is a no-op.
+ /// Removes a child view from this view. If the view was not a child of this view, this is a no-op.
/// </summary>
- /// <pre>This View(the parent) has been initialized. The child view is not the same as the parent view.</pre>
- /// <param name="child">The child</param>
+ /// <pre>This view (the parent) has been initialized. The child view is not the same as the parent view.</pre>
+ /// <param name="child">The child.</param>
public abstract void Remove( View view );
/// <summary>
- /// Retrieves child view by index.
+ /// Retrieves the child view by the index.
/// </summary>
- /// <pre>The View has been initialized.</pre>
- /// <param name="index">The index of the child to retrieve</param>
- /// <returns>The view for the given index or empty handle if children not initialized</returns>
+ /// <pre>The view has been initialized.</pre>
+ /// <param name="index">The index of the child to retrieve.</param>
+ /// <returns>The view for the given index or empty handle if children are not initialized.</returns>
public abstract View GetChildAt( uint index );
/// <summary>
- /// Get the parent of this container
+ /// Gets the parent of this container.
/// </summary>
/// <pre>The child container has been initialized.</pre>
- /// <returns>The parent container</returns>
+ /// <returns>The parent container.</returns>
protected abstract Container GetParent();
/// <summary>
- /// Get the number of children for this container
+ /// Gets the number of children for this container.
/// </summary>
/// <pre>The container has been initialized.</pre>
- /// <returns>number of children</returns>
+ /// <returns>The number of children.</returns>
protected abstract UInt32 GetChildCount();
/// <summary>
- /// Get the parent Container
+ /// Gets the parent container.
/// Read only
/// </summary>
/// <pre>The child container has been initialized.</pre>
- /// <returns>The parent container</returns>
+ /// <returns>The parent container.</returns>
public Container Parent
{
get
}
/// <summary>
- /// Get the number of children for this container
+ /// Gets the number of children for this container.
/// Read only
/// </summary>
/// <pre>The container has been initialized.</pre>
- /// <returns>number of children</returns>
+ /// <returns>The number of children.</returns>
public uint ChildCount
{
get