i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix URLs in the development docs

Browse Source 
* Fix dead links where possible
* Use online instead of local links to the BeBook

Change-Id: I250117dcccc0026925c56545cca7e3b4467f2c78
Reviewed-on: https://review.haiku-os.org/c/811
Reviewed-by: Adrien Destugues <[email protected]>
This commit is contained in:
Humdinger
2019-01-29 16:12:55 +00:00
committed by waddlesplash
parent 80cdc887fa
commit e705c841d7
15 changed files with 44 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/develop/kits/interface/usecases/BDeskbarUseCases.html
+11 -26
View File
@@ -23,7 +23,7 @@ The document has the following sections:</P>
<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/Deskbar/Deskbar.html">here in the Be Book</A>.
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BDeskbar.html">here in the Be Book</A>.
</P>
<A NAME="usecases"></A><H2>BDeskbar Use Cases:</H2>
@@ -41,7 +41,7 @@ persists.</P></LI>
<LI><P><B>Add Item 1:</B> The AddItem() member function can be used to take a passed in pointer to
a BView and send it to the deskbar for inclusion in its shelf. This BView must be archivable
and must be exported by the application (for details on how to do this,
<A HREF="http://bedriven.be-in.org/articles/replicant/III_027-stepping%20up%20to%20the%20deskbar.html">this article</A>
<A HREF="https://www.haiku-os.org/legacy-docs/benewsletter/Issue4-27.html#DevWorkshop4-27">this article</A>
may help). The item will be added and the id of the new item will be passed back to the caller
through a pointer to an int32.</P></LI>
@@ -49,10 +49,10 @@ through a pointer to an int32.</P></LI>
shelf by passing a pointer to an entry_ref. The file pointed to by this entry_ref should be
an addon that exports the symbol "BView *instantiate_deskbar_item(float, float)". This entry point is used to
get a BView which it can display in the shelf. More information on this mechanism can be found in
the <A HREF="file:///boot/beos/documentation/Be%20Book/Release%20Notes/Deskbar.html">Deskbar Release Notes</A>
but not in the Be Book proper. The item id of the added item is passed back in an int32 pointer
provided by the caller. NOTE: The source code for the deskbar found in
<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/StatusView.cpp?rev=1.5&content-type=text/vnd.viewcvs-markup">TReplicantTray::LoadAddon()</A>
the <A HREF="http://www.tycomsystems.com/beos/BeBook/Release%20Notes/Deskbar.html">Deskbar Release Notes</A> but not in the Be Book proper. The item id of the added item is passed back in an int32 pointer
provided by the caller.<BR />
NOTE: The source code for the Deskbar found in
<A HREF="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/StatusView.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n625">TReplicantTray::LoadAddon()</A>
indicates that it also looks for a symbol called "BView *instantiate_deskbar_entry(image_id, entry_ref*, float, float)"
first, but there is no documentation on this.</P></LI>
@@ -122,23 +122,8 @@ when in left or right top position.</P></LI>
<A NAME="implement"></A><H2>BDeskbar Implementation:</H2>
<P>Internally, the BDeskbar uses a BMessenger to communicate with the deskbar itself.
The source code from the OpenTracker project will be used as a reference for this effort.
You can find the deskbar source code here:</P>
<BLOCKQUOTE>
<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/">http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/</A>
</BLOCKQUOTE>
<P>Specifically, the code which handles communicating with the BDeskbar class can be found
here:</P>
<BLOCKQUOTE>
<A HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&amp;content-type=text/vnd.viewcvs-markup</A>
</BLOCKQUOTE>
<P>The following describes the messages used to communicate between BDeskbar and the deskbar
itself.</P>
<P>Internally, the BDeskbar uses a BMessenger to communicate with the deskbar itself.<BR />
<A HREF="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp">The code which handles communicating with the BDeskbar</A> is described below.</P>
<H3>AddItem:</H3>
@@ -175,7 +160,7 @@ theMsg.AddInt32("id", theID); // This is the id of the new item
<P>Note that in both cases, the deskbar does not set the what code of the reply. Checking the
source code for
<A href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">TBarWindow::AddItem()</A>
<A href="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n571">TBarWindow::AddItem()</A>
confirms this.
@@ -200,7 +185,7 @@ theMsg.AddBool("exists", IDorNameExists()); // This is a true/false value whi
<P>Note that the deskbar does not set the what code of the reply. Checking the source code
for
<A href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">TBarWindow::ItemExists()</A>
<A href="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n513">TBarWindow::ItemExists()</A>
confirms this.</P>
@@ -227,7 +212,7 @@ theMsg.AddInt32("id", theID); // This is the id corresponding to the nam
<P>Note that the deskbar does not set the what code of the reply. Checking the source code
for
<A href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/opentracker/opentracker/deskbar/BarWindow.cpp?rev=1.2&content-type=text/vnd.viewcvs-markup">TBarWindow::ItemInfo()</A>
<A href="https://git.haiku-os.org/haiku/tree/src/apps/deskbar/BarWindow.cpp?id=f10faf61aca9496c0c2cfa04deb1acf47164b650#n486">TBarWindow::ItemInfo()</A>
confirms this.</P>
docs/develop/kits/interface/usecases/BPolygonUseCases.html
+2 -2
View File
@@ -23,8 +23,8 @@ The document has the following sections:</P>
<P>The BPolygon class is used to hold information about a shape composed of a series of straight
lines (ie a polygon). On its own, it just describes the shape and can only be drawn by passing
it to a BView. The best source of source of information for the BPolygon interface can be found
<A HREF="file:///boot/beos/documentation/Be%20Book/The%20Interface%20Kit/Polygon.html">here in the Be Book</A>.
it to a BView. The best source of source of information for the BPolygon is
<A HREF="https://www.haiku-os.org/legacy-docs/bebook/BPolygon.html">the Be Book page about it</A>.
</P>
<A NAME="usecases"></A><H2>BPolygon Use Cases:</H2>