BButton: Document AdoptSystemColors() and HasSystemColors() in the Haiku Book.

Change-Id: Ibe72cc796738e90beee9388eaba95342ab48640d Reviewed-on: https://review.haiku-os.org/c/haiku/+/8898 Reviewed-by: Adrien Destugues <[email protected]> Tested-by: Commit checker robot <[email protected]>
2025-06-30 14:57:07 +00:00
parent 15c87be3ea
commit b515400884
1 changed files with 43 additions and 0 deletions
@@ -560,3 +560,46 @@

 	\since BeOS R3
 */
+
+
+/*!
+	\name Color Adoption
+*/
+
+
+//! @{
+
+
+/*!
+	\fn BButton::AdoptSystemColors()
+	\brief Adopts document colors tinted to match panel background if uneditable.
+
+	- \c B_CONTROL_BACKGROUND_COLOR for ViewUIColor()
+	- \c B_CONTROL_BACKGROUND_COLOR for LowUIColor()
+	- \c B_CONTROL_TEXT_COLOR for HighUIColor()
+
+	This is reimplemented from BView which uses panel colors.
+
+	\see BView::AdoptSystemColors(), HasSystemColors()
+
+	\since Haiku R1
+*/
+
+
+/*!
+	\fn bool BButton::HasSystemColors() const
+	\brief Tests whether or not the button is using system colors.
+
+	- \c B_DOCUMENT_BACKGROUND_COLOR for ViewUIColor()
+	- \c B_DOCUMENT_BACKGROUND_COLOR for LowUIColor()
+	- \c B_DOCUMENT_TEXT_COLOR for HighUIColor()
+
+	\returns \c true if button is using system colors, \c false otherwise.
+
+	\see AdoptSystemColors()
+
+	\since Haiku R1
+*/
+
+
+//! @}