API Docs: add skeletons for BUrl and BAlignment and complete BAlert

This commit is contained in:
Niels Sascha Reedijk 2019-09-09 21:12:13 +01:00
parent 97ae75c75b
commit eaf8dff073
3 changed files with 992 additions and 0 deletions

View File

@ -22,6 +22,7 @@
/*!
\enum alert_type
\ingroup interface
\brief Type of alert.
Determines which icon (if any) is displayed in the alert dialog.
Choose one option. If the constructor doesn't include an
@ -83,6 +84,7 @@
/*!
\enum button_spacing
\ingroup interface
\brief Method of spacing of buttons in alerts.
Determines how the buttons on the alert dialog are spaced relative
to each other. Choose one option. If the constructor doesn't include a
@ -169,6 +171,21 @@ int32 button_index = alert->Go();
*/
/*!
\fn BAlert::BAlert()
\brief Create an unconfigured BAlert dialog.
This method creates an unconfigured BAlert. You can configure it with
methods like SetText(), SetType() and SetButtonSpacing.
It is advised to use one of the other constructors that help set up all
the configuration in one go, instead of doing it piece by piece with this
method.
\since BeOS R3
*/
/*!
\fn BAlert::BAlert(const char* title, const char* text,
const char* button1, const char* button2, const char* button3,
@ -302,6 +319,67 @@ int32 button_index = alert->Go();
//! @}
/*!
\fn alert_type BAlert::Type() const
\brief Get the alert_type of this alert.
\return Returns one of the values from the alert_type enum.
\since BeOS R3
*/
/*!
\fn void BAlert::SetType(alert_type type)
\brief Set the type of the alert.
\param type Pass one of the alert_type enum values to set the type.
\since BeOS R3
*/
/*!
\fn void BAlert::SetIcon(BBitmap *bitmap)
\brief Set a custom icon for the alert.
\param bitmap A valid BBitmap. The bitmap is copied.
\since BeOS R3
*/
/*!
\fn void BAlert::SetText(const char *text)
\brief Set the text for the alert.
\param text The text you want the alert to display.
\since BeOS R3
*/
/*!
\fn void BAlert::SetButtonSpacing(button_spacing spacing)
\brief Set the button spacing for the alert.
\param spacing Pass one of the button_spacing values to configure the
spacing.
\since BeOS R3
*/
/*!
\fn void BAlert::SetButtonWidth(button_width width)
\brief Set the button width for the buttons of the alert.
\param width Pass one of the button_width values to configure the width.
\since BeOS R3
*/
/*!
\fn void BAlert::SetShortcut(int32 index, char key)
\brief Sets the shortcut character which is mapped to a button at the
@ -390,6 +468,29 @@ int32 button_index = alert->Go();
*/
/*!
\fn void BAlert::AddButton(const char *label, char key=0)
\brief Adds a button to the alert.
\param label The label of the button.
\param key The key a user can press to quickly select this button.
\since BeOS R3
*/
/*!
\fn int32 BAlert::CountButtons() const
\brief Counts the number of buttons in the alert.
\return The number of buttons in this alert window.
\see AddButton() and ButtonAt()
\since BeOS R3
*/
/*!
\fn BButton* BAlert::ButtonAt(int32 index) const
\brief Returns a pointer to the BButton at the specified \a index.

View File

@ -0,0 +1,209 @@
/*
* Copyright 2019 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* Name, email@email.com
*
* Corresponds to:
* headers/os/interface/Alignment.h hrev32745
* src/kits/interface/Alignment.cpp hrev18649
*/
/*!
\file Alignment.h
\ingroup interface
\brief Undocumented file.
\since Haiku R1
*/
/*!
\class BAlignment
\ingroup interface
\ingroup libbe
\brief Undocumented class.
\since Haiku R1
*/
/*!
\var alignment BAlignment::horizontal
\brief Undocumented public variable
\since Haiku R1
*/
/*!
\var vertical_alignment BAlignment::vertical
\brief Undocumented public variable
\since Haiku R1
*/
/*!
\fn BAlignment::BAlignment()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BAlignment::BAlignment(const BAlignment &other)
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BAlignment::BAlignment(alignment horizontal, vertical_alignment vertical)
\brief Undocumented public method
\param horizontal Undocumented
\param vertical Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn alignment BAlignment::Horizontal() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn vertical_alignment BAlignment::Vertical() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn float BAlignment::RelativeHorizontal() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn float BAlignment::RelativeVertical() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn void BAlignment::SetHorizontal(alignment horizontal)
\brief Undocumented public method
\param horizontal Undocumented
\since Haiku R1
*/
/*!
\fn void BAlignment::SetVertical(vertical_alignment vertical)
\brief Undocumented public method
\param vertical Undocumented
\since Haiku R1
*/
/*!
\fn bool BAlignment::IsHorizontalSet() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BAlignment::IsVerticalSet() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BAlignment::operator==(const BAlignment &other) const
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BAlignment::operator!=(const BAlignment &other) const
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BAlignment & BAlignment::operator=(const BAlignment &other)
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/

682
docs/user/support/Url.dox Normal file
View File

@ -0,0 +1,682 @@
/*
* Copyright 2019 Haiku, Inc. All rights reserved.
* Distributed under the terms of the MIT License.
*
* Authors:
* Name, email@email.com
*
* Corresponds to:
* headers/os/support/Url.h hrev52332
* src/kits/support/Url.cpp hrev52332
*/
/*!
\file Url.h
\ingroup support
\brief Undocumented file.
\since Haiku R1
*/
/*!
\class BUrl
\ingroup support
\ingroup libbe
\brief Undocumented class.
\since Haiku R1
*/
/*!
\fn BUrl::BUrl(const char *url)
\brief Undocumented public method
\param url Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl::BUrl(BMessage *archive)
\brief Undocumented public method
\param archive Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl::BUrl(const BUrl &other)
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl::BUrl(const BUrl &base, const BString &relative)
\brief Undocumented public method
\param base Undocumented
\param relative Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl::BUrl(const BPath &path)
\brief Undocumented public method
\param path Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl::BUrl()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual virtual BUrl::~BUrl()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetUrlString(const BString &url)
\brief Undocumented public method
\param url Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetProtocol(const BString &scheme)
\brief Undocumented public method
\param scheme Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetUserName(const BString &user)
\brief Undocumented public method
\param user Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetPassword(const BString &password)
\brief Undocumented public method
\param password Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn void BUrl::SetAuthority(const BString &authority)
\brief Undocumented public method
\param authority Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetHost(const BString &host)
\brief Undocumented public method
\param host Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetPort(int port)
\brief Undocumented public method
\param port Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetPath(const BString &path)
\brief Undocumented public method
\param path Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetRequest(const BString &request)
\brief Undocumented public method
\param request Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl& BUrl::SetFragment(const BString &fragment)
\brief Undocumented public method
\param fragment Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::UrlString() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::Protocol() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::UserName() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::Password() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::UserInfo() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::Host() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn int BUrl::Port() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::Authority() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::Path() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::Request() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BString& BUrl::Fragment() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::IsValid() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasProtocol() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasUserName() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasPassword() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasUserInfo() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasHost() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasPort() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasAuthority() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasPath() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasRequest() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasFragment() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn void BUrl::UrlEncode(bool strict=false)
\brief Undocumented public method
\param strict Undocumented
\since Haiku R1
*/
/*!
\fn void BUrl::UrlDecode(bool strict=false)
\brief Undocumented public method
\param strict Undocumented
\since Haiku R1
*/
/*!
\fn status_t BUrl::IDNAToAscii()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn status_t BUrl::IDNAToUnicode()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::HasPreferredApplication() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BString BUrl::PreferredApplication() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn status_t BUrl::OpenWithPreferredApplication(bool onProblemAskUser=true) const
\brief Undocumented public method
\param onProblemAskUser Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::operator==(BUrl &other) const
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn bool BUrl::operator!=(BUrl &other) const
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BUrl& BUrl::operator=(const BUrl &other)
\brief Undocumented public method
\param other Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BUrl& BUrl::operator=(const BString &string)
\brief Undocumented public method
\param string Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn const BUrl& BUrl::operator=(const char *string)
\brief Undocumented public method
\param string Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BUrl::operator const char *() const
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn static static BString BUrl::UrlEncode(const BString &url, bool strict=false, bool directory=false)
\brief Undocumented public method
\param url Undocumented
\param strict Undocumented
\param directory Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn static static BString BUrl::UrlDecode(const BString &url, bool strict=false)
\brief Undocumented public method
\param url Undocumented
\param strict Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn static static BArchivable* BUrl::Instantiate(BMessage *archive)
\brief Undocumented public method
\param archive Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/