Commit Graph

493 Commits

Author SHA1 Message Date
Niels Sascha Reedijk d450c75ca7 HaikuBook: Add skeletons for various undocumented interface kit classes
* BAbstractLayoutItem
 * BAffineTransform
 * BCardLayout
 * BCardView
 * BChannelControl
 * BChannelSlider
 * BDeskbar
 * BGridLayoutBuilder
 * BGridView
 * BGroupLayoutBuilder
 * BGroupView
 * BInput
 * BOptionControl
 * BSeparatorView
 * BSpaceLayoutItem
 * BSplitLayoutBuilder
 * BSplitView
 * BStatusBar
2019-09-20 21:03:54 +01:00
Niels Sascha Reedijk 4679af2788 API Docs: add various missing elements to support kit.
* Adds missing methods to BArchivable, BList and BString.
* Add missing defines to SupportDefs.h
2019-09-19 21:57:13 +01:00
Niels Sascha Reedijk 2afda31c8f API Docs: add skeletons for BBufferedDataIO, BStringList and BStackOrHeapArray 2019-09-19 21:57:13 +01:00
Niels Sascha Reedijk eaf8dff073 API Docs: add skeletons for BUrl and BAlignment and complete BAlert 2019-09-19 21:57:12 +01:00
Niels Sascha Reedijk 97ae75c75b API Docs: add missing methods of class BView 2019-09-19 21:57:11 +01:00
Niels Sascha Reedijk f6be862fc5 API Docs: small fix for InterfaceDefs.dox 2019-09-19 21:57:11 +01:00
Niels Sascha Reedijk 03b52202d1 API Docs: various AppKit improvements 2019-09-02 06:59:51 +01:00
Niels Sascha Reedijk 5b2a8e3aef API Docs: Add new methods to BMessage 2019-09-02 06:59:50 +01:00
Niels Sascha Reedijk a72f3582be API Docs: Add placeholder for Key.h, KeyStore.h and Notification.h 2019-09-02 06:59:50 +01:00
Augustin Cavalier e5d0c9094d BView: Add a B_SCROLL_VIEW_AWARE flag.
* This indicates the view will manage whatever scrollbars are targeted
   to it.
 * Use _B_RESERVED7_ for this. It's been RESERVED since BeOS R5
   (I guess it was probably something on some older BeOS version?)
   and we don't really care about BeOS R4 ABI compatibility, so
   that should be fine.
 * Update BScrollView to not touch BScrollBar range/proportion
   when the target view has this set.
 * Update BListView to set this flag, always.

Fixes #14871.

Change-Id: I17027f3b63ef28da1e735c5393593496c415dce3
Reviewed-on: https://review.haiku-os.org/c/998
Reviewed-by: Adrien Destugues <pulkomandy@gmail.com>
2019-02-03 18:04:13 +00:00
Augustin Cavalier 5b0e5c0ac6 BScrollView: Automatically update the scrollbar proportions in layout mode.
Since we know what size the target view is / wants to be, we can automatically
set the range, steps, and proportion trivially. In non-layout mode, we retain
the old behavior. Applications or views that need custom scrolling behavior almost
certainly will be using BScrollBars directly and not this, so this should not be
"wasted computation" in pretty much any case.

Greatly improves the appearance and UX of the default case of a layouted
view inside a BScrollView.

Change-Id: Ia6ff6ee14df96799c579e15d274fd4c849675577
Reviewed-on: https://review.haiku-os.org/c/892
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2019-01-24 18:52:39 +00:00
Augustin Cavalier ad7cab8751 Haiku Book: Update BFont docs. 2019-01-23 23:10:33 -05:00
PulkoMandy 4c1d9cf74e Fix "since" entries in BPropertyInfo.
These methods and fields are missing from the R4 and R5 Be Book, but are
mentionned in the R4 release notes and present in the R5 headers.

Change-Id: I4de8298449bd66e0ee7fe0b52690552916314123
Reviewed-on: https://review.haiku-os.org/820
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2019-01-03 19:09:22 +00:00
Augustin Cavalier 414b21c497 docs/user: Fix description of bigtime_t. 2018-12-14 18:59:17 -05:00
Adrien Destugues 151343ebc8 BLooper: API to hijack existing thread.
I need this to use loopers in WebKit, which spawns threads and expects
to be able to turn them into event loops later on.

This is the pattern already used in BApplication, we may as well make it
available elsewhere.

Change-Id: I5939ca89d33cb3bcc92567b302c2038d976af598
Reviewed-on: https://review.haiku-os.org/735
Reviewed-by: Axel Dörfler <axeld@pinc-software.de>
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2018-12-02 21:36:31 +00:00
François Revol 8865af3950 BApplication docs: fix example
Fixes #14520.
2018-09-24 19:30:05 +02:00
Augustin Cavalier c3ac0a72a6 BMenuItem: Remove ourselves from the super menu on destruct.
This fixes the (intermittently) crashing test added in the previous commit,
and should also fix #12024 and #14348.

Note that this is a slight behavioral departure from BeOS, though since
BeOS crashed when this was done previously, it shouldn't cause any
other problems.

Change-Id: I90b6132ff7741b8d6cb601375a9b11fc3ffacb40
Reviewed-on: https://review.haiku-os.org/541
Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2018-09-12 01:15:48 +00:00
Adrien Destugues 03e5dd5273 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.
2018-08-28 19:14:57 +02:00
Augustin Cavalier 63cb446249 docs/user: Remove extra comment opener.
It made the second one show up in the documentation.
2018-08-15 14:09:07 -04:00
John Scipione e79c33c93f BResources SetToImage docs: update variable name in retval (tiny) 2018-06-27 10:05:52 -07:00
Alexander G. M. Smith f12d3b3477 Update BListItem::SetHeight() docs with selection box warning.
The cached top coordinate of each BListItem isn't updated when you
change the height of the item, leading to confusing highlighting and
incorrect mouse clicks.  Rather than fixing it, this just documents a
workaround or two to force an update of the cached coordinates.
2018-02-17 00:26:34 +00:00
Augustin Cavalier 96efe3b3c0 docs/user: Migrate Axel's "Introduction to the Launch Daemon" from Trac. 2018-01-10 16:12:14 -05:00
Augustin Cavalier 97f4f2b559 Migrate the BTextMailComponent docs to the Haiku Book. 2017-12-26 13:59:25 -05:00
Augustin Cavalier 95c9effd68 Migrate the BMailComponent docs to the Haiku Book.
I've updated the docs to match the current BMailComponent, documented
new functions, and cleaned up the MailComponent.h file to at least
somewhat match our coding style.

First in a series (there are 3 more old API docs on the Mail Kit in that
"Public API" folder.)
2017-12-25 19:43:51 -05:00
John Scipione 1061001b46 API Docs: minor brief description updates 2017-11-10 15:24:34 -08:00
John Scipione 9e72aeccc5 LayoutBuilder docs: document missing paramters 2017-11-10 15:11:10 -08:00
John Scipione a960a58cd7 Docs: remove ; causing it not to find copydetails 2017-11-10 15:00:05 -08:00
John Scipione 6f6c9e0069 BDurationFormat::Format docs, update method params
Also a tiny style fix in the header, put const qualifier
on same line
2017-11-10 14:59:33 -08:00
John Scipione 021c2fec4f BNumberFormat docs: remove const qualifier 2017-11-10 14:45:39 -08:00
John Scipione e08fce49e7 BDurationFormat docs: update ctor docs 2017-11-10 14:41:28 -08:00
John Scipione 1e994bc7cf Docs: Fix some warnings
... by adding book_ prefix in front of section labels in book.dox
2017-11-10 14:17:55 -08:00
John Scipione d4a640ec2e Replace pt0 and pt1 with start and end 2017-11-09 13:58:35 -08:00
John Scipione 44b874666a API docs: it's => its fix 2017-11-09 13:23:55 -08:00
Augustin Cavalier 9d5b0fdaa1 docs/user: Upgrade to Doxygen 1.8.13.
Also tweak the footer CSS a bit, and fix an unclosed comment in the
fs_interface docs (spotted via a warning in Doxygen output.)
2017-10-01 11:19:37 -04:00
Kacper Kasper 22423870a5 docs/user: Update CSS for Doxygen 1.8.12. 2017-09-30 17:26:46 +02:00
Akshay Agarwal defdefa89a docs/user: Update locale kit description.
- Delete the introduction from the kits list page, as it is already
under locale_intro.
- Update the description in locale_intro.
- Since the locale kit now lives in libbe, delete the paragraph about
libraries from the intro, and move the still relevant part about
liblocalestub to the catalog translation macros description in
Catalog.dox.
2017-09-06 07:47:47 +02:00
Adrien Destugues 05d9795db3 Add some docs for BLayoutBuilder::Grid. 2017-08-13 09:05:29 +02:00
Augustin Cavalier 0bb2d0ecad docs/user: Status codes are defined in Errors.h, not Error.h. 2017-06-14 18:05:31 -04:00
Adrien Destugues a19a18f553 Rework BCollator API
- Strength is now set once, instead of at each comparison, to improve
  performance and fix potential locking issues
- Add a way to enable "numeric" collation (aka "natural order")
2017-05-29 08:52:43 +02:00
Andrew Lindesay f943fa465c JSON Parser : Documentation migration
This commit migrates the JSON overview documentation that
was recently added from Markdown to Doxygen.
2017-05-26 21:05:14 +12:00
Alexander G. M. Smith 5e7964b0a9 Remove Spurious B_BEOS_DATA_DIRECTORY
There is no DATA directory in BeOS, and its FindDir() doesn't implement
it.  No need for a confusing backwards compatibility to something that
doesn't exist (had my hopes up, was going to move some non-executable
files from AddOns to Data in a program that works in BeOS and Haiku).

The removed enum label doesn't change the directory_which enum order
or count, as it was aliasing the value of another existing enum label
(B_SYSTEM_DATA_DIRECTORY).

Fixes #13470

Signed-off-by: Axel Dörfler <axeld@pinc-software.de>
2017-05-08 22:17:53 +02:00
Augustin Cavalier b95e90657e docs/user: Update search URL following docs migration. 2017-04-15 16:28:06 -04:00
John Scipione 1eed6ef172 BString docs: document IStartsWith() and IEndsWith() 2017-02-21 18:03:03 -08:00
Augustin Cavalier 7abafe9f3f Revert "Revert "Switch from DejaVu to Noto font""
This reverts commit 2423ba8470.
2017-02-19 12:09:33 -05:00
Augustin Cavalier 2423ba8470 Revert "Switch from DejaVu to Noto font"
This reverts commit 945566ff43.

As discussed on the mailing lists and with Humdinger off-list:
 * The general design concensus tends slightly towards DejaVu, as metrics
   of DejaVu look much better (DejaVu 12 and Noto 13 are roughly the same size,
   but Noto has much wider margins with that)
 * While Noto does have a wider set of fonts with support for lots of
   different languages, DejaVu actually has built-in support for more
   Unicode languages (the default Noto has, as far as I can tell, only
   Latin/Greek/Cyrillic [2416 glyphs], while DejaVu also has Armenian, Georgian,
   and a few other scripts too [5119 glyphs].)
 * The worse rendering of DejaVu appears to have been somewhat rectified by
   disabling the average-based subpixel filter in app_server.
2017-02-18 14:36:36 -05:00
Augustin Cavalier b6f76ebe71 s/OpenBeOS License/MIT License/ universally, as they're the same thing.
Fixes #8681.
2017-02-09 22:09:56 -05:00
Augustin Cavalier 1de2d72812 Partially revert "ReadMe & docs: The Haiku Book has moved to www.haiku-os.org/docs/api."
This mostly reverts commit 75b219d35a.
The changes to the image URLs in Alert.dox are still needed, so I
didn't revert those.

As per discussion on the mailing list and IRC.
2017-02-01 15:23:54 -05:00
Augustin Cavalier 75b219d35a ReadMe & docs: The Haiku Book has moved to www.haiku-os.org/docs/api. 2017-02-01 11:22:01 -05:00
Augustin Cavalier 92b020b5ea docs/user: Update infobox CSS to match the new colors. 2017-01-28 13:33:19 -05:00
Augustin Cavalier 44460faf4d docs/user: Make string literals in code blocks gray.
Class and function reference links are also blue, so this distinguishes
them from each other.
2017-01-28 13:26:20 -05:00