Adding use cases for the BDeskbar class.

git-svn-id: file:///srv/svn/repos/haiku/trunk/current@990 a95241bf-73f2-0310-859d-f6bbb57e9c96
2002-09-07 03:05:55 +00:00
parent b98d9a335a
commit 9f9f4b0c19
1 changed files with 78 additions and 0 deletions
@@ -0,0 +1,78 @@
+<HTML>
+<!-- $Id: BDeskbarUseCases.html,v 1.1 2002/09/07 03:05:55 jrand Exp $ -->
+<HEAD>
+<TITLE>BDeskbar Use Cases and Implementation Details</TITLE>
+</HEAD>
+
+<BODY BGCOLOR="white" LINK="#000067" VLINK="#000067" ALINK="#0000FF">
+
+<FONT FACE="Verdana,Arial,Helvetica,sans-serif" SIZE="-1">
+
+<H1>BDeskbar Use Cases and Implementation Details:</H1>
+
+<P>This document describes the BDeskbar interface and some basics of how it is implemented.
+The document has the following sections:</P>
+
+<OL>
+<LI><A HREF="#interface">BDeskbar Interface</A></LI>
+<LI><A HREF="#usecases">BDeskbar Use Cases</A></LI>
+<LI><A HREF="#implement">BDeskbar Implementation</A></LI>
+</OL>
+
+<A NAME="interface"></A><H2>BDeskbar Interface:</H2>
+
+<P>The BDeskbar class is a simple class for getting information from the deskbar and for modifying
+it from your application.  The best source of source of information for the BDeskbar interface can be found
+<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Application%20Kit/MessageQueue.html">here in the Be Book</A>.
+</P>
+
+<A NAME="usecases"></A><H2>BDeskbar Use Cases:</H2>
+
+<P>The following use cases cover the BDeskbar functionality:</P>
+
+<OL>
+<LI><P><B>Construction:</B> A BDeskbar does not take any arguments when it is constructed.  The
+BDeskbar instance creates a connection to the deskbar in order to get and change its state.</P></LI>
+
+<LI><P><B>Destruction:</B> When a BDeskbar is deconstructed, the application's connection to the
+deskbar is closed.  However any change to the deskbar's state made through the BDeskbar instance
+persists.</P></LI>
+
+<LI><P><B>Add Item 1:</B> </P></LI>
+
+<LI><P><B>Add Item 2:</B> </P></LI>
+
+<LI><P><B>Remove Item 1:</B> </P></LI>
+
+<LI><P><B>Remove Item 2:</B> </P></LI>
+
+<LI><P><B>Count Items:</B> </P></LI>
+
+<LI><P><B>Has Item 1:</B> </P></LI>
+
+<LI><P><B>Has Item 2:</B> </P></LI>
+
+<LI><P><B>Get Item Info 1:</B> </P></LI>
+
+<LI><P><B>Get Item Info 2:</B> </P></LI>
+
+<LI><P><B>Frame:</B> </P></LI>
+
+<LI><P><B>Location:</B> </P></LI>
+
+<LI><P><B>Is Expanded:</B> </P></LI>
+
+<LI><P><B>Set Location:</B> </P></LI>
+
+<LI><P><B>Expand:</B> </P></LI>
+
+</OL>
+
+<A NAME="implement"></A><H2>BDeskbar Implementation:</H2>
+
+<P>Internally, the BDeskbar uses a BMessenger to communicate with the deskbar itself.  The
+actual messages used to perform its tasks will be documented here once they are determined.
+The source code from the OpenTracker project will be used as a reference for this effort.</P>
+
+</BODY>
+</HTML>