Commit Graph

423 Commits

Author SHA1 Message Date
looncraz
7f9368cae5 Set*UIColor, etc.
The inseparable changes necessary to support live color updating across the
system in a sane, safe, and performant manner.

BView gains:

HasSystemColors()
HasDefaultColors()
AdoptSystemColors()
AdoptParentColors()
AdoptViewColor(BView*)
SetViewUIColor(color_which, float tint)
SetHighUIColor(...
SetLowUIColor(...
ViewUIColor(float* tint)
HighUIColor(...
LowUIColor(...
DelayedInvalidate()

BWindow gains a simple helper method:
IsOffscreenWindow()

BMessage gains:

AddColor()
FindColor()
GetColor()
HasColor()            * allegedly this API is deprecated, but I implemented it anyway
ReplaceColor()
SetColor()

Previous private ColorTools methods are made public and moved into GraphicsDefs:

mix_color, blend_color, disable_color

These are fully compatible with BeOS dan0 R5.1 methods and are just code cleanup
of BeOS example code under the OpenTracker license.

In addition, four new colors are created:
B_LINK_TEXT_COLOR
B_LINK_HOVER_COLOR
B_LINK_ACTIVE_COLOR
B_LINK_VISITED_COLOR

These changes are documented in their proper user documentation files.

In addition, due to a history rewrite, B_FOLLOW_LEFT_TOP has been defined and
used in lieu of B_FOLLOW_TOP | B_FOLLOW_LEFT and is included in this commit.

On the app_server side, the following has changed:

Add DelayedMessage - a system by which messages can be sent at a scheduled time,
and can also be merged according to set rules.  A single thread is used to service the
message queue and multiple recipients can be set for each message.
Desktop gains the ability to add message ports to a DelayedMessage so that
said messages can target either all applications or all windows, as needed.

Desktop maintains a BMessage which is used to queue up all pending color changes
and the delayed messaging system is used to enact these changes after a short
period of time has passed.  This prevents abuse and allows the system to merge
repeated set_ui_color events into one event for client applications, improving
performance drastically.

In addition, B_COLORS_UPDATED is sent to the BApplication, which forwards the message
to each BWindow.  This is done to improve performance over having the app_server
independently informing each window.

Decorator changes are live now, which required some reworking.

Signed-off-by: Augustin Cavalier <waddlesplash@gmail.com>
2016-01-04 06:48:22 -05:00
Adrien Destugues
ed3c7f8fc2 BTranslatorRoster::Default docs: Further rework and typo fixes 2015-10-26 18:43:35 +01:00
Markus Himmel
7676393722 Minor correction in BTranslatorRoster documentation 2015-10-26 18:40:31 +01:00
Axel Dörfler
2e17b6504f BLaunchRoster::ResetStickyEvent() added.
* Used to unflag sticky events that already have been triggered once.
2015-10-25 14:41:17 +01:00
Axel Dörfler
7cd19b7e5c launch_daemon: Implemented sticky events, and registration.
* Sticky events are events that keep their signal raised, ie. even if
  a job is initialized afterwards, it will still be triggered.
* Consolidated naming for external events.
* Events are now registered once they are actually being used. This
  allows them to allocate the resources they need to do their thing.
2015-10-17 14:16:26 +02:00
Augustin Cavalier
1ea54e567e docs/user: BAlert: Fix incorrect ::TextView() docs.
TextView() returns *the* BTextView the BAlert is using, not a new
TextView with the contents of the BAlert (which is what this seemed to
imply).
2015-08-26 14:42:11 -04:00
Michael Lotz
5ca445dfc6 FS module docs: Add documentation for entry_cache_add_missing().
This was missed when introducing the feature in hrev49558. Thanks Jérôme
for the pointer!

Also add a note explaining that update operations on cached entries and
the removal of uncached entries are safe.
2015-08-21 21:08:15 +02:00
Michael Lotz
86b5886640 BReferenceable docs: Fix a typo and one obvious mixup. 2015-08-02 23:19:07 +02:00
Axel Dörfler
58fd8acd78 Added BLaunchRoster documentation.
* Untested, and could use some more love when it comes to possible
  error codes.
2015-07-22 20:45:38 +02:00
Augustin Cavalier
4d556706b5 docs/user: s/http:/https:/. 2015-07-21 18:24:37 -04:00
Augustin Cavalier
8868ca02ed docs/user: TabView: Fix erroneous descriptions of Select() and Deselect(). 2015-07-14 11:26:39 -04:00
John Scipione
0afa3a4850 BRoster docs: force be_roster to link, lang cleanup 2015-07-07 16:22:31 -07:00
John Scipione
e8aeed6eef Fix BRoster::Launch documentation const mismatch 2015-07-07 16:22:29 -07:00
John Scipione
49a56113ef Fix typo: on => one 2015-07-07 16:22:27 -07:00
John Scipione
046d20afd1 BScrollView::ScrollBar return val docs past tense 2015-07-07 16:22:25 -07:00
John Scipione
5a2ed95c23 Clarify ScrollView::ScrollBar() direction parameter in docs 2015-07-07 16:22:23 -07:00
John Scipione
c466b4daeb IK: Change orientation param name to direction
for ScrollView::ScrollBar in ScrollView.h and the documentation. This makes
the parameter name consisent and fixes a doxygen warning.
2015-07-07 16:22:22 -07:00
Augustin Cavalier
93c67e52f3 docs/user: Add/update some '\sa's. 2015-07-07 11:57:42 -04:00
Augustin Cavalier
0426b7e7e8 docs/user: Fix documentation of BTab::SetLabel. 2015-07-07 11:57:40 -04:00
Michael Lotz
0bba9b9752 Fix some typos and whitespace in BLayout docs. 2015-04-15 00:30:55 +02:00
Augustin Cavalier
51362d85d8 Haiku Book: Doxyfile: eat __attribute__ directives.
Without this, Doxygen attempts to parse __attribute__ directives
and often outputs garbage instead of properly parsing them, so just
exclude them from the documentation.

Fixes some incorrect function listings in BString documentation
and possibly more elsewhere.
2015-04-06 18:00:39 -04:00
Augustin Cavalier
64f7e980a4 BString docs: don't have tags in hsection titles. 2015-04-06 17:51:04 -04:00
Augustin Cavalier
906283b6d6 Haiku Book: Make the layout introduction somewhat more professional. 2015-03-25 11:47:29 -04:00
Augustin Cavalier
9d6780b587 Haiku Book: disable class diagrams.
The last time this was discussed on the ML, the consensus was that
the text lists were nicer than the diagrams (with only one objection).
For the minority that wants class diagrams, it's easy enough to reverse
this one-line change.
2015-03-25 11:37:10 -04:00
Augustin Cavalier
e6ecb3fc07 Haiku Book: Midi2 fixes.
* Automatic whitespace cleanup.
 * Removed all of Midi2 from the "libbe" group, as they aren't part of it
 * Get rid of the redundant "libmidi2" group, as all of midi2 is already in
   the "MIDI 2 Kit" group, and the docs explicitly state that the MIDI 2 Kit
   has its own library.
2015-03-25 11:30:01 -04:00
Augustin Cavalier
aa6ef6658c Haiku Book: fix device drivers group definition.
Also removed the "Keyboard" group definition, which was broken. There
wasn't anything in that group, and there's only one page on the
keyboard anyway.
2015-03-25 11:23:51 -04:00
Augustin Cavalier
c86c9e29d3 ScrollView docs: make parameter name match the header file. 2015-02-27 02:39:07 -05:00
Augustin Cavalier
4cb2c39774 Haiku Book: compatibility: list all authors at the top of the file as per convention.
All of the other .dox files here list authors at the top of the file
in a standard (non-Doxygen) comment, so do the same here.

I've listed the file as copyright 2011, as (according to Git) that's
the last time it was functionally changed. I also added a few people
in as being authors of the file who seem to have made significant
changes to it.
2015-02-11 19:14:20 -05:00
Augustin Cavalier
aa01bfe571 Haiku Book: fix some typos.
The possessive form of "it" is "its", not "it's" ("it's" is just
shorthand for "it is").

Closes #11712.
2015-02-11 19:04:38 -05:00
Augustin Cavalier
82d26eb239 Haiku Book: old Midi Kit: fix link to the BeBook.
That online copy of the BeBook went offline some time ago, and we
now host one, so point to that instead.
2015-02-11 19:00:18 -05:00
John Scipione
b1a9f638da Add preliminary Net Kit intro by Philippe Houdoin
From here:
http://philippe.houdoin.free.fr/phil/beos/openbeos/network_kit/overview.html
2015-01-27 19:16:54 -05:00
John Scipione
d04b3b772c Remove trailing . from titles 2015-01-27 19:15:11 -05:00
John Scipione
7177815b20 Use regular bullets for lists, matches User Guide 2015-01-27 19:14:36 -05:00
John Scipione
3cf6e692c8 Fix typos in BReferencable docs 2015-01-27 18:17:16 -05:00
Adrien Destugues
f6c0340128 Add documentation for BReference and BReferenceable. 2015-01-26 13:59:55 +01:00
John Scipione
a82d6bdd3e Replace 'should' with 'must' in BInvoker::SendMessage() docs 2015-01-22 13:43:45 -05:00
John Scipione
a66de90c49 Clarify BInvoker::SetMessage() docs some more
The language on SetMessage() was still a bit confusing, this should
hopefully clear it up.
2015-01-20 20:13:57 -05:00
Adrien Destugues
412f030b0f Some clarifications to BInvoker docs. 2015-01-17 13:41:55 +01:00
John Scipione
db7ef1292a Add BMessageRunner docs 2015-01-16 18:00:50 -05:00
John Scipione
2eb2dcfabe Small fixes to BMessenger docs 2015-01-16 17:59:48 -05:00
John Scipione
fd3c25a928 Move the operator function docs over too 2015-01-16 16:43:34 -05:00
John Scipione
973984649c Add BMessenger docs 2015-01-16 16:43:33 -05:00
John Scipione
19ce061e0b Update BInvoker docs to clarify them
...with notes from PulkoMandy and Axel. Also added author credits.

Class documentation is moved to the appropriate method and then \sa
is used to point to the documentation so it is only documented in
one location.

Added some text about how the interaction between BInvoker and
BHandler and/or BLooper works.

BMessenger needs to be documented to understand how SetTimeout() is
suppose to work, refer to BeBook for now.
2015-01-16 14:24:32 -05:00
John Scipione
23f1ce0756 BInvoker::Timeout was introduced in BeOS R5, not R3 2015-01-15 15:33:27 -05:00
John Scipione
9bf7584d96 Add BInvoker docs 2015-01-15 15:30:23 -05:00
Adrien Destugues
c50131cd6a Complete and rework BJoystick docs. 2015-01-10 11:44:58 +01:00
mandar
c8e6696716 Add documentation for the Open method in the joystick class. 2015-01-10 11:31:02 +01:00
Adrien Destugues
6aa4d138bf LayoutBuilder: document C++ method chaining behavior
Fixes #8515.
2015-01-07 17:29:35 +01:00
Augustin Cavalier
c09cca4a79 BSize docs: fix description of B_SIZE_UNSET.
Thanks Ingo for noticing!
2015-01-07 15:34:49 +01:00
Augustin Cavalier
ab00c90d87 Create docs for BSize class.
Fixes #11713.

Signed-off-by: Adrien Destugues <pulkomandy@gmail.com>
2015-01-07 08:29:33 +01:00