History log of /haiku/docs/user/app/Message.dox
Revision Date Author Comments
# fe88ae51 29-Aug-2020 John Scipione <jscipione@gmail.com>

AppKit: BMessage Add/Find/Get/Has/ReplaceNodeRef

This allows you to pass node_ref's around like you can entry_ref's.

Added node_ref_flatten(), node_ref_unflatten() and node_ref_swap() to
MessageUtils. These are close cousins to entry_ref_flatten(),
entry_ref_unflatten(), and entry_ref_swap() but for node_ref's.

Added B_NODE_REF_TYPE to TypeConstants.h in the Support Kit.

Added B_NODE_REF_TYPE to Debugger and ByteOrder in Support Kit,
B_NODE_REF_TYPE is treated the same as a B_REF_TYPE (entry_ref).

Add documentation for new NodeRef methods and B_NODE_REF_TYPE.

Change-Id: I32c6ed276bf1a7894a835b9fc9de5a882c35883c
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3182
Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>


# 19a1dd49 08-Sep-2020 John Scipione <jscipione@gmail.com>

API docs: update TypeConstants.h documentation

Most of these say Haiku R1 but were introduced in BeOS R3 or R5.

Add documentation for a bunch of missing types.

Some minor updates to BMessage docs.

Change-Id: Ic6ad1439bd280ab8bc641a6e5c99b93ead512cbc
Reviewed-on: https://review.haiku-os.org/c/haiku/+/3199
Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>


# 5b2a8e3a 01-Sep-2019 Niels Sascha Reedijk <niels.reedijk@gmail.com>

API Docs: Add new methods to BMessage


# 03e5dd52 28-Aug-2018 Adrien Destugues <pulkomandy@pulkomandy.tk>

Fix documentation for BMessage::Previous

The function allocates a message because it uses lazy initialization,
however the user does not get ownership and must not delete it.

Fixes #14413.


# 873cc554 27-Apr-2016 John Scipione <jscipione@gmail.com>

Message docs: fix errors


# 7f9368ca 09-Dec-2015 looncraz <looncraz@looncraz.net>

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>


# 20721297 22-Dec-2014 Adrien Destugues <pulkomandy@gmail.com>

BMessage: remove unimplemented GetPointer from headers and docs

* This was never implemented and no one noticed until now.
* A default value for a pointer doesn't make that much sense anyway, so
using the FindPointer method is fine.


# ac9714d8 11-Jun-2014 John Scipione <jscipione@gmail.com>

Update App Kit Documentation.

The biggest change is the addition of \since to each method. I've gone
through old versions of the BeBook and documented what version of BeOS
each method was introduced in. I'm only counting production releases
so I'm starting with BeOS R3 ignoring all DR and PR releases. Likewise,
all methods new to Haiku are listed as being introduced \since Haiku R1
ignoring alpha releases.


# 6e8749b2 18-Mar-2013 John Scipione <jscipione@gmail.com>

Update BMessage documentation adding Get* methods.

Also, lots of little cleanups: formatting, adding return statements and
return values where they were missing, fix spelling mistakes, add newlines to
separate command blocks, remove trailing whitespace.


# 41611c9c 07-Feb-2013 John Scipione <jscipione@gmail.com>

Assign class docs for app and support to libbe group, not libroot


# db5b891d 07-Feb-2013 John Scipione <jscipione@gmail.com>

Move app and support class docs from libbe to libroot.

Also a few more style and spelling fixes.


# 820dca4d 06-Feb-2013 John Scipione <jscipione@gmail.com>

Big docs cleanup.

* Fixed headers including:
- All rights reserved not All Rights Reserved.
- name, email@domain.com not name <email@domain.com>
- tabs and spaces
- Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.


# a33f8fbd 09-Aug-2011 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

Merge work by John Scipione on the Haiku Book.
* Some new classes documented
* Screenshots for the interface kit controls
* A lot of typo fixes
* Some css tweaks

This has some backporting to the current version of Doxygen, since
there are experiments to get coloring similar to the one in the Be
Book that will hopefully be upstreamed in Doxygen.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 6fd8b07a 27-Dec-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Add a note about using messages for data storage. Thanks to mlotz for telling me this functionality was underexposed in the current docs.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23170 a95241bf-73f2-0310-859d-f6bbb57e9c96


# dcdb9964 15-Oct-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Phase I of the Message.dox file

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22564 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 207212972e96a9c3954d0d3ececcd85291b1e18a 22-Dec-2014 Adrien Destugues <pulkomandy@gmail.com>

BMessage: remove unimplemented GetPointer from headers and docs

* This was never implemented and no one noticed until now.
* A default value for a pointer doesn't make that much sense anyway, so
using the FindPointer method is fine.


# ac9714d8a432d321345e9ba8425164b59a4f0d50 11-Jun-2014 John Scipione <jscipione@gmail.com>

Update App Kit Documentation.

The biggest change is the addition of \since to each method. I've gone
through old versions of the BeBook and documented what version of BeOS
each method was introduced in. I'm only counting production releases
so I'm starting with BeOS R3 ignoring all DR and PR releases. Likewise,
all methods new to Haiku are listed as being introduced \since Haiku R1
ignoring alpha releases.


# 6e8749b27f2037e989d01a69b1c335ca45c8800f 18-Mar-2013 John Scipione <jscipione@gmail.com>

Update BMessage documentation adding Get* methods.

Also, lots of little cleanups: formatting, adding return statements and
return values where they were missing, fix spelling mistakes, add newlines to
separate command blocks, remove trailing whitespace.


# 41611c9c5ea45ec256c7a448f8984d28cb72dc54 07-Feb-2013 John Scipione <jscipione@gmail.com>

Assign class docs for app and support to libbe group, not libroot


# db5b891db2923d1787c15b9c97f0e49a30949fdb 07-Feb-2013 John Scipione <jscipione@gmail.com>

Move app and support class docs from libbe to libroot.

Also a few more style and spelling fixes.


# 820dca4df6c7bf955c46e8f6521b9408f50b2900 06-Feb-2013 John Scipione <jscipione@gmail.com>

Big docs cleanup.

* Fixed headers including:
- All rights reserved not All Rights Reserved.
- name, email@domain.com not name <email@domain.com>
- tabs and spaces
- Authors: not Documented by:
* Renamed string.dox to String.dox
* Renamed midixxx.dox files to MidiXxx.dox
* Moved images into images subdirectories and updated Doxfile.
* Re-format all files with tabs instead of spaces.
* Fix many spelling mistakes.
* Added all files, classes, structs, and enums to libbe group.


# a33f8fbdec035ff322cc1ef364877a3092e99a09 09-Aug-2011 Adrien Destugues <pulkomandy@pulkomandy.ath.cx>

Merge work by John Scipione on the Haiku Book.
* Some new classes documented
* Screenshots for the interface kit controls
* A lot of typo fixes
* Some css tweaks

This has some backporting to the current version of Doxygen, since
there are experiments to get coloring similar to the one in the Be
Book that will hopefully be upstreamed in Doxygen.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96


# 6fd8b07afce51fc741e30c42a390eb8381dc2daa 27-Dec-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Add a note about using messages for data storage. Thanks to mlotz for telling me this functionality was underexposed in the current docs.

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@23170 a95241bf-73f2-0310-859d-f6bbb57e9c96


# dcdb99648113d2b9d2c44d5a89f142a407a38d3d 15-Oct-2007 Niels Sascha Reedijk <niels.reedijk@gmail.com>

Phase I of the Message.dox file

git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22564 a95241bf-73f2-0310-859d-f6bbb57e9c96