From 9f9f4b0c19a9600c9d3ae2e4c908e4808011b469 Mon Sep 17 00:00:00 2001 From: jrand Date: Sat, 7 Sep 2002 03:05:55 +0000 Subject: [PATCH] Adding use cases for the BDeskbar class. git-svn-id: file:///srv/svn/repos/haiku/trunk/current@990 a95241bf-73f2-0310-859d-f6bbb57e9c96 --- .../app/usecases/BDeskbarUseCases.html | 78 +++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 docs/develop/app/usecases/BDeskbarUseCases.html diff --git a/docs/develop/app/usecases/BDeskbarUseCases.html b/docs/develop/app/usecases/BDeskbarUseCases.html new file mode 100644 index 0000000000..45d6b16535 --- /dev/null +++ b/docs/develop/app/usecases/BDeskbarUseCases.html @@ -0,0 +1,78 @@ + + + +BDeskbar Use Cases and Implementation Details + + + + + + +

BDeskbar Use Cases and Implementation Details:

+ +

This document describes the BDeskbar interface and some basics of how it is implemented. +The document has the following sections:

+ +
    +
  1. BDeskbar Interface
    2. +
  2. BDeskbar Use Cases
    3. +
  3. BDeskbar Implementation
    4. +
+ +

BDeskbar Interface:

+ +

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 +here in the Be Book. +

+ +

BDeskbar Use Cases:

+ +

The following use cases cover the BDeskbar functionality:

+ +
    +

  1. Construction: 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.

    2. + +

  2. Destruction: 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.

    3. + +

  3. Add Item 1:

    4. + +

  4. Add Item 2:

    5. + +

  5. Remove Item 1:

    6. + +

  6. Remove Item 2:

    7. + +

  7. Count Items:

    8. + +

  8. Has Item 1:

    9. + +

  9. Has Item 2:

    10. + +

  10. Get Item Info 1:

    11. + +

  11. Get Item Info 2:

    12. + +

  12. Frame:

    13. + +

  13. Location:

    14. + +

  14. Is Expanded:

    15. + +

  15. Set Location:

    16. + +

  16. Expand:

    17. + +
+ +

BDeskbar Implementation:

+ +

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.

+ + +