C Bcode Side Item
Back to the main documentation page
public interface IItem
{
/// <summary>
/// Initialise the item.
/// </summary>
/// <param name="sd"> The shared dictionary client instance for
/// storing all the shared data for this item. </param>
/// <param name="path"> The unique key to identify this item in
/// the shared dictionary.</param>
/// <param name="master"> True if this item instance is the
/// original one created.</param>
/// <param name="currentUserKey"> The key of the current user
/// (the owner if master is true)</param>
void StartItem(GroupLab.Networking.SharedDictionary sd,
string path,
bool master,
string currentUserKey);
/// <summary>
/// Stop the item running. Close down all running processes and
/// clean up the shared dictionary.
/// </summary>
void StopItem( );
/// <summary>
/// Return a display for the tile view of this item at a
/// particular focus.
/// </summary>
/// <param name="focus">Value in the range 1-100. Indicates user's
/// focus on the item.</param>
/// <returns>A control that displays this item.</returns>
System.Windows.Forms.Control GetTile(int focus);
/// <summary>
/// Return a display for the transient focus view of this item at
/// a particular awareness.
/// </summary>
/// <param name="size">The maximum size that the application
/// allows for this view.</param>
/// <returns>A control that displays this item.</returns>
System.Windows.Forms.Control GetTransientFocus(Size size);
/// <summary>
/// A handle for when the user wishes to separate this item from
/// the application.
/// The result of calling this method should be a sparate form or
/// application that allows the user full interaction.
/// </summary>
void SeparateItem( );
}
{
/// <summary>
/// Initialise the item.
/// </summary>
/// <param name="sd"> The shared dictionary client instance for
/// storing all the shared data for this item. </param>
/// <param name="path"> The unique key to identify this item in
/// the shared dictionary.</param>
/// <param name="master"> True if this item instance is the
/// original one created.</param>
/// <param name="currentUserKey"> The key of the current user
/// (the owner if master is true)</param>
void StartItem(GroupLab.Networking.SharedDictionary sd,
string path,
bool master,
string currentUserKey);
/// <summary>
/// Stop the item running. Close down all running processes and
/// clean up the shared dictionary.
/// </summary>
void StopItem( );
/// <summary>
/// Return a display for the tile view of this item at a
/// particular focus.
/// </summary>
/// <param name="focus">Value in the range 1-100. Indicates user's
/// focus on the item.</param>
/// <returns>A control that displays this item.</returns>
System.Windows.Forms.Control GetTile(int focus);
/// <summary>
/// Return a display for the transient focus view of this item at
/// a particular awareness.
/// </summary>
/// <param name="size">The maximum size that the application
/// allows for this view.</param>
/// <returns>A control that displays this item.</returns>
System.Windows.Forms.Control GetTransientFocus(Size size);
/// <summary>
/// A handle for when the user wishes to separate this item from
/// the application.
/// The result of calling this method should be a sparate form or
/// application that allows the user full interaction.
/// </summary>
void SeparateItem( );
}