Commit Graph

794 Commits

Author SHA1 Message Date
autonielx
9c59cb0692 Update userguide translations, leavengood as nielx 2016-05-06 20:48:02 +02:00
autonielx
b98538a5b5 Remove duplicate welcome and userguide directories 2016-05-06 20:28:17 +02:00
autonielx
bd3f6a54ec Update userguide translations, leavengood as nielx 2016-05-06 04:15:13 +02:00
John Scipione
57c4212174 LaunchRoster docs: Add warning not to use class
...as it is not yet finalized.
2016-04-29 15:51:32 -07:00
John Scipione
b5665b7243 AbstractSocket docs: Document reuseAddr param of Bind() 2016-04-29 15:43:45 -07:00
John Scipione
24cb14bc3d BTabView: Style fixes
Fix misleading indentation

remove extra newline

just a newline

selTabRect => selectedTabRect
2016-04-29 14:31:31 -07:00
John Scipione
3490eda827 ControlLook: Rename border param to borderStyle
border vs. borders is confusing.

BTabView: Rename border param to borderStyle

BTabView docs: rename border param to borderStyle

enumerate border styles in docs
2016-04-29 14:31:05 -07:00
John Scipione
4d52d1a8ca Add BPropertyInfo class docs 2016-04-27 11:10:34 -07:00
John Scipione
686b774894 LaunchRoster: doment data param to quiet warning 2016-04-27 11:10:32 -07:00
John Scipione
b855c871b7 Add private app headers to Doxyfile
needed for LaunchRoster which has gone private.
2016-04-27 11:10:32 -07:00
John Scipione
9a243c1b2a Fix errors in fs_interface.dox 2016-04-27 11:10:31 -07:00
John Scipione
873cc5542e Message docs: fix errors 2016-04-27 11:10:31 -07:00
John Scipione
c5fe2948ba BColorControl docs: pointer style
(really minor change that doesn't affect output)
2016-03-12 19:10:39 -08:00
John Scipione
8db20d05cb BColorControl: Standardize on useOffscreen
...instead of doubleBuffered for the flag that specifies whether or not to
draw using an offscreen buffer.

Also remove the (not currently used) text from the docs since the parameter
is being used.
2016-03-12 19:10:38 -08:00
Augustin Cavalier
f2df0cfe93 interface_guidelines: Add a Haiku-esque stylesheet.
Fixes #11782.
2016-03-07 14:29:24 -05:00
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
Augustin Cavalier
896c0b7543 Move doc from src/kits/network to docs/net.
Thanks Adrien for reviewing!
2015-06-30 09:34:02 -04:00
Alexander G. M. Smith
143edb7460 docs: makefile-engine: add missing HTML tags.
Fixes #12063.

Signed-off-by: Augustin Cavalier <waddlesplash@gmail.com>
2015-06-01 18:28:17 -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
Alexander von Gluck IV
9f76848eca doc/rpi1: Fix old reference to old FDT blob 2015-03-07 16:52:43 -06:00
Alexander von Gluck IV
1ac3785a72 doc: Update rpi1/rpi2 documentation. 2015-03-07 16:50:51 -06:00
Augustin Cavalier
c86c9e29d3 ScrollView docs: make parameter name match the header file. 2015-02-27 02:39:07 -05:00
autonielx
f3f0969580 Update userguide translations 2015-02-23 18:29:56 +01:00
Augustin Cavalier
cf76c29456 interface_guidelines: add a convert.sh script that uses XMLTO.
Works on Linux, doesn't work on Haiku. It appears xsltproc tries
to fetch the DTD and XSL stylesheets (which doesn't work, for some reason
it wasn't built with HTTP support, and I can't figure out why). Even
when telling it to use the preinstalled XSL & DTDs using --catalog,
it still tries to download the files...
2015-02-13 11:26:28 -05:00
Augustin Cavalier
7d6915b4d0 Interface Guidelines: migrate to docs/, use DocBookCSS.
DocBookCSS is a mostly-pure-CSS2 implementation of the DocBook standard.
Unlike DocBookXSL which relies on transforming the XML, it utilizes the
XML-styling features of modern web browsers to display the DocBook.

Its appearance still is a long way from the Haiku Book and Userguide, but
it looks (mostly) the same as the old DocBookXSL so we can stop using that.
Eventually we just need to make DocBookCSS use our styling.
2015-02-12 17:08:04 -05:00
Augustin Cavalier
644fa5a938 src/documentation: delete the old HaikuUserGuide.txt.
Written by DarkWyrm, this user guide has been long since superseded by
the new HTML-based User Guide, which has everything this did and then
some, with the exception of the "History" section. That section
does seem like it could be useful somewhere, so I've moved it to
its own file in the "docs/misc" directory.
2015-02-12 10:37:22 -05:00