diff --git a/docs/user/interface/AbstractLayoutItem.dox b/docs/user/interface/AbstractLayoutItem.dox new file mode 100644 index 0000000000..5e359af96b Binary files /dev/null and b/docs/user/interface/AbstractLayoutItem.dox differ diff --git a/docs/user/interface/AffineTransform.dox b/docs/user/interface/AffineTransform.dox new file mode 100644 index 0000000000..53edf68430 --- /dev/null +++ b/docs/user/interface/AffineTransform.dox @@ -0,0 +1,1160 @@ +/* + * 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/AffineTransform.h hrev52913 + * src/kits/interface/AffineTransform.cpp hrev51931 + */ + + +/*! + \file AffineTransform.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BAffineTransform + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \var const double BAffineTransform::kDefaultEpsilon + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var double BAffineTransform::sx + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var double BAffineTransform::shy + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var double BAffineTransform::shx + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var double BAffineTransform::sy + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var double BAffineTransform::tx + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var double BAffineTransform::ty + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform::BAffineTransform() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform::BAffineTransform(double sx, double shy, double shx, double sy, double tx, double ty) + \brief Undocumented public method + + \param sx Undocumented + \param shy Undocumented + \param shx Undocumented + \param sy Undocumented + \param tx Undocumented + \param ty Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform::BAffineTransform(const BAffineTransform ©From) + \brief Undocumented public method + + \param copyFrom Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BAffineTransform::~BAffineTransform() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual bool BAffineTransform::IsFixedSize() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual type_code BAffineTransform::TypeCode() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual ssize_t BAffineTransform::FlattenedSize() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BAffineTransform::Flatten(void *buffer, ssize_t size) const + \brief Undocumented public method + + \param buffer Undocumented + \param size Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BAffineTransform::Unflatten(type_code code, const void *buffer, ssize_t size) + \brief Undocumented public method + + \param code Undocumented + \param buffer Undocumented + \param size Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::Apply(double *x, double *y) const + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::ApplyInverse(double *x, double *y) const + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BAffineTransform::Apply(const BPoint &point) const + \brief Undocumented public method + + \param point Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BAffineTransform::ApplyInverse(const BPoint &point) const + \brief Undocumented public method + + \param point Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::Apply(BPoint *point) const + \brief Undocumented public method + + \param point Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::ApplyInverse(BPoint *point) const + \brief Undocumented public method + + \param point Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::Apply(BPoint *points, uint32 count) const + \brief Undocumented public method + + \param points Undocumented + \param count Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::ApplyInverse(BPoint *points, uint32 count) const + \brief Undocumented public method + + \param points Undocumented + \param count Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::TranslateBy(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::TranslateBy(const BPoint &delta) + \brief Undocumented public method + + \param delta Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::PreTranslateBy(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::TranslateByCopy(double x, double y) const + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::TranslateByCopy(const BPoint &delta) const + \brief Undocumented public method + + \param delta Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::RotateBy(double angle) + \brief Undocumented public method + + \param angle Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::RotateBy(const BPoint ¢er, double angle) + \brief Undocumented public method + + \param center Undocumented + \param angle Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::PreRotateBy(double angleRadians) + \brief Undocumented public method + + \param angleRadians Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::RotateByCopy(double angle) const + \brief Undocumented public method + + \param angle Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::RotateByCopy(const BPoint ¢er, double angle) const + \brief Undocumented public method + + \param center Undocumented + \param angle Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::ScaleBy(double scale) + \brief Undocumented public method + + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::ScaleBy(const BPoint ¢er, double scale) + \brief Undocumented public method + + \param center Undocumented + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::ScaleBy(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::ScaleBy(const BPoint ¢er, double x, double y) + \brief Undocumented public method + + \param center Undocumented + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::ScaleBy(const BPoint &scale) + \brief Undocumented public method + + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::ScaleBy(const BPoint ¢er, const BPoint &scale) + \brief Undocumented public method + + \param center Undocumented + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::PreScaleBy(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ScaleByCopy(double scale) const + \brief Undocumented public method + + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ScaleByCopy(const BPoint ¢er, double scale) const + \brief Undocumented public method + + \param center Undocumented + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ScaleByCopy(double x, double y) const + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ScaleByCopy(const BPoint ¢er, double x, double y) const + \brief Undocumented public method + + \param center Undocumented + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ScaleByCopy(const BPoint &scale) const + \brief Undocumented public method + + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ScaleByCopy(const BPoint ¢er, const BPoint &scale) const + \brief Undocumented public method + + \param center Undocumented + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::SetScale(double scale) + \brief Undocumented public method + + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::SetScale(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::ShearBy(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::ShearBy(const BPoint ¢er, double x, double y) + \brief Undocumented public method + + \param center Undocumented + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::ShearBy(const BPoint &shear) + \brief Undocumented public method + + \param shear Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::ShearBy(const BPoint ¢er, const BPoint &shear) + \brief Undocumented public method + + \param center Undocumented + \param shear Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ShearByCopy(double x, double y) const + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ShearByCopy(const BPoint ¢er, double x, double y) const + \brief Undocumented public method + + \param center Undocumented + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ShearByCopy(const BPoint &shear) const + \brief Undocumented public method + + \param shear Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::ShearByCopy(const BPoint ¢er, const BPoint &shear) const + \brief Undocumented public method + + \param center Undocumented + \param shear Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::Multiply(const BAffineTransform &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::PreMultiply(const BAffineTransform &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::MultiplyInverse(const BAffineTransform &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::PreMultiplyInverse(const BAffineTransform &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform & BAffineTransform::operator=(const BAffineTransform ©From) + \brief Undocumented public method + + \param copyFrom Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BAffineTransform::operator==(const BAffineTransform &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BAffineTransform::operator!=(const BAffineTransform &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::operator*=(const BAffineTransform &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform & BAffineTransform::operator/=(const BAffineTransform &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::operator*(const BAffineTransform &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::operator/(const BAffineTransform &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BAffineTransform BAffineTransform::operator~() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BAffineTransform::IsValid(double epsilon=kDefaultEpsilon) const + \brief Undocumented public method + + \param epsilon Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BAffineTransform::IsIdentity(double epsilon=kDefaultEpsilon) const + \brief Undocumented public method + + \param epsilon Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BAffineTransform::IsDilation(double epsilon=kDefaultEpsilon) const + \brief Undocumented public method + + \param epsilon Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BAffineTransform::IsEqual(const BAffineTransform &other, double epsilon=kDefaultEpsilon) const + \brief Undocumented public method + + \param other Undocumented + \param epsilon Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::Invert() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::FlipX() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::FlipY() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const BAffineTransform& BAffineTransform::Reset() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn double BAffineTransform::Determinant() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn double BAffineTransform::InverseDeterminant() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::GetTranslation(double *tx, double *ty) const + \brief Undocumented public method + + \param tx Undocumented + \param ty Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn double BAffineTransform::Rotation() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn double BAffineTransform::Scale() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::GetScale(double *sx, double *sy) const + \brief Undocumented public method + + \param sx Undocumented + \param sy Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BAffineTransform::GetScaleAbs(double *sx, double *sy) const + \brief Undocumented public method + + \param sx Undocumented + \param sy Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BAffineTransform::GetAffineParameters(double *translationX, double *translationY, double *rotation, double *scaleX, double *scaleY, double *shearX, double *shearY) const + \brief Undocumented public method + + \param translationX Undocumented + \param translationY Undocumented + \param rotation Undocumented + \param scaleX Undocumented + \param scaleY Undocumented + \param shearX Undocumented + \param shearY Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BAffineTransform BAffineTransform::AffineTranslation(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BAffineTransform BAffineTransform::AffineRotation(double angle) + \brief Undocumented public method + + \param angle Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BAffineTransform BAffineTransform::AffineScaling(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BAffineTransform BAffineTransform::AffineScaling(double scale) + \brief Undocumented public method + + \param scale Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BAffineTransform BAffineTransform::AffineShearing(double x, double y) + \brief Undocumented public method + + \param x Undocumented + \param y Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/CardLayout.dox b/docs/user/interface/CardLayout.dox new file mode 100644 index 0000000000..665ea2f940 --- /dev/null +++ b/docs/user/interface/CardLayout.dox @@ -0,0 +1,315 @@ +/* + * 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/CardLayout.h hrev43514 + * src/kits/interface/CardLayout.cpp hrev49019 + */ + + +/*! + \file CardLayout.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BCardLayout + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BCardLayout::BCardLayout() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BCardLayout::BCardLayout(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BCardLayout::~BCardLayout() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BLayoutItem* BCardLayout::VisibleItem() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BCardLayout::VisibleIndex() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BCardLayout::SetVisibleItem(int32 index) + \brief Undocumented public method + + \param index Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BCardLayout::SetVisibleItem(BLayoutItem *item) + \brief Undocumented public method + + \param item Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BCardLayout::BaseMinSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BCardLayout::BaseMaxSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BCardLayout::BasePreferredSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BAlignment BCardLayout::BaseAlignment() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual bool BCardLayout::HasHeightForWidth() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BCardLayout::GetHeightForWidth(float width, float *min, float *max, float *preferred) + \brief Undocumented public method + + \param width Undocumented + \param min Undocumented + \param max Undocumented + \param preferred Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BCardLayout::Archive(BMessage *into, bool deep=true) const + \brief Undocumented public method + + \param into Undocumented + \param deep Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BCardLayout::Perform(perform_code d, void *arg) + \brief Undocumented public method + + \param d Undocumented + \param arg Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BCardLayout::Instantiate(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BCardLayout::AllArchived(BMessage *archive) const + \brief Undocumented protected method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BCardLayout::AllUnarchived(const BMessage *from) + \brief Undocumented protected method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BCardLayout::ItemArchived(BMessage *into, BLayoutItem *item, int32 index) const + \brief Undocumented protected method + + \param into Undocumented + \param item Undocumented + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BCardLayout::ItemUnarchived(const BMessage *from, BLayoutItem *item, int32 index) + \brief Undocumented protected method + + \param from Undocumented + \param item Undocumented + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BCardLayout::LayoutInvalidated(bool children=false) + \brief Undocumented protected method + + \param children Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BCardLayout::DoLayout() + \brief Undocumented protected method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual bool BCardLayout::ItemAdded(BLayoutItem *item, int32 atIndex) + \brief Undocumented protected method + + \param item Undocumented + \param atIndex Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BCardLayout::ItemRemoved(BLayoutItem *item, int32 fromIndex) + \brief Undocumented protected method + + \param item Undocumented + \param fromIndex Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/CardView.dox b/docs/user/interface/CardView.dox new file mode 100644 index 0000000000..48a8c78377 --- /dev/null +++ b/docs/user/interface/CardView.dox @@ -0,0 +1,128 @@ +/* + * 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/CardView.h hrev49943 + * src/kits/interface/CardView.cpp hrev49977 + */ + + + + +/*! + \file CardView.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BCardView + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BCardView::BCardView() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BCardView::BCardView(const char *name) + \brief Undocumented public method + + \param name Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BCardView::BCardView(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BCardView::~BCardView() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BCardView::SetLayout(BLayout *layout) + \brief Undocumented public method + + \param layout Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BCardLayout* BCardView::CardLayout() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BCardView::Perform(perform_code d, void *arg) + \brief Undocumented public method + + \param d Undocumented + \param arg Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BCardView::Instantiate(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/ChannelControl.dox b/docs/user/interface/ChannelControl.dox new file mode 100644 index 0000000000..909f403059 --- /dev/null +++ b/docs/user/interface/ChannelControl.dox @@ -0,0 +1,667 @@ +/* + * 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/ChannelControl.h hrev49977 + * src/kits/interface/ChannelControl.cpp hrev49495 + */ + + + + +/*! + \file ChannelControl.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BChannelControl + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BChannelControl::BChannelControl(BRect frame, const char *name, const char *label, BMessage *model, int32 channelCount=1, uint32 resizingMode=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW) + \brief Undocumented public method + + \param frame Undocumented + \param name Undocumented + \param label Undocumented + \param model Undocumented + \param channelCount Undocumented + \param resizingMode Undocumented + \param flags Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BChannelControl::BChannelControl(const char *name, const char *label, BMessage *model, int32 channelCount=1, uint32 flags=B_WILL_DRAW) + \brief Undocumented public method + + \param name Undocumented + \param label Undocumented + \param model Undocumented + \param channelCount Undocumented + \param flags Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BChannelControl::BChannelControl(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BChannelControl::~BChannelControl() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::Archive(BMessage *data, bool deep=true) const + \brief Undocumented public method + + \param data Undocumented + \param deep Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual void BChannelControl::Draw(BRect updateRect)=0 + \brief Undocumented public method + + \param updateRect Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual void BChannelControl::MouseDown(BPoint where)=0 + \brief Undocumented public method + + \param where Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual void BChannelControl::KeyDown(const char *bytes, int32 numBytes)=0 + \brief Undocumented public method + + \param bytes Undocumented + \param numBytes Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::FrameResized(float newWidth, float newHeight) + \brief Undocumented public method + + \param newWidth Undocumented + \param newHeight Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::SetFont(const BFont *font, uint32 mask=B_FONT_ALL) + \brief Undocumented public method + + \param font Undocumented + \param mask Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::AttachedToWindow() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::DetachedFromWindow() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::ResizeToPreferred() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual void BChannelControl::GetPreferredSize(float *width, float *height)=0 + \brief Undocumented public method + + \param width Undocumented + \param height Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::MessageReceived(BMessage *message) + \brief Undocumented public method + + \param message Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BHandler* BChannelControl::ResolveSpecifier(BMessage *message, int32 index, BMessage *specifier, int32 what, const char *property) + \brief Undocumented public method + + \param message Undocumented + \param index Undocumented + \param specifier Undocumented + \param what Undocumented + \param property Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::GetSupportedSuites(BMessage *data) + \brief Undocumented public method + + \param data Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::SetModificationMessage(BMessage *message) + \brief Undocumented public method + + \param message Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BMessage* BChannelControl::ModificationMessage() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::Invoke(BMessage *message=NULL) + \brief Undocumented public method + + \param message Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::InvokeChannel(BMessage *message=NULL, int32 fromChannel=0, int32 channelCount=-1, const bool *_mask=NULL) + \brief Undocumented public method + + \param message Undocumented + \param fromChannel Undocumented + \param channelCount Undocumented + \param _mask Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BChannelControl::InvokeNotifyChannel(BMessage *message=NULL, uint32 kind=B_CONTROL_INVOKED, int32 fromChannel=0, int32 channelCount=-1, const bool *_mask=NULL) + \brief Undocumented public method + + \param message Undocumented + \param kind Undocumented + \param fromChannel Undocumented + \param channelCount Undocumented + \param _mask Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelControl::SetValue(int32 value) + \brief Undocumented public method + + \param value Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::SetCurrentChannel(int32 index) + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BChannelControl::CurrentChannel() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual int32 BChannelControl::CountChannels() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual int32 BChannelControl::MaxChannelCount() const =0 + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::SetChannelCount(int32 count) + \brief Undocumented public method + + \param count Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BChannelControl::ValueFor(int32 channel) const + \brief Undocumented public method + + \param channel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual int32 BChannelControl::GetValue(int32 *_values, int32 fromChannel, int32 channelCount) const + \brief Undocumented public method + + \param _values Undocumented + \param fromChannel Undocumented + \param channelCount Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BChannelControl::SetValueFor(int32 channel, int32 value) + \brief Undocumented public method + + \param channel Undocumented + \param value Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::SetValue(int32 fromChannel, int32 channelCount, const int32 *values) + \brief Undocumented public method + + \param fromChannel Undocumented + \param channelCount Undocumented + \param values Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BChannelControl::SetAllValue(int32 values) + \brief Undocumented public method + + \param values Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BChannelControl::SetLimitsFor(int32 channel, int32 minimum, int32 maximum) + \brief Undocumented public method + + \param channel Undocumented + \param minimum Undocumented + \param maximum Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BChannelControl::GetLimitsFor(int32 channel, int32 *_minimum, int32 *_maximum) const + \brief Undocumented public method + + \param channel Undocumented + \param _minimum Undocumented + \param _maximum Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::SetLimitsFor(int32 fromChannel, int32 channelCount, const int32 *minima, const int32 *maxima) + \brief Undocumented public method + + \param fromChannel Undocumented + \param channelCount Undocumented + \param minima Undocumented + \param maxima Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::GetLimitsFor(int32 fromChannel, int32 channelCount, int32 *minima, int32 *maxima) const + \brief Undocumented public method + + \param fromChannel Undocumented + \param channelCount Undocumented + \param minima Undocumented + \param maxima Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BChannelControl::SetLimits(int32 minimum, int32 maximum) + \brief Undocumented public method + + \param minimum Undocumented + \param maximum Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BChannelControl::GetLimits(int32 *_minimum, int32 *_maximum) const + \brief Undocumented public method + + \param _minimum Undocumented + \param _maximum Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual bool BChannelControl::SupportsIndividualLimits() const =0 + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::SetLimitLabels(const char *minLabel, const char *maxLabel) + \brief Undocumented public method + + \param minLabel Undocumented + \param maxLabel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BChannelControl::MinLimitLabel() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BChannelControl::MaxLimitLabel() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::SetLimitLabelsFor(int32 channel, const char *minLabel, const char *maxLabel) + \brief Undocumented public method + + \param channel Undocumented + \param minLabel Undocumented + \param maxLabel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelControl::SetLimitLabelsFor(int32 fromChannel, int32 channelCount, const char *minLabel, const char *maxLabel) + \brief Undocumented public method + + \param fromChannel Undocumented + \param channelCount Undocumented + \param minLabel Undocumented + \param maxLabel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BChannelControl::MinLimitLabelFor(int32 channel) const + \brief Undocumented public method + + \param channel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BChannelControl::MaxLimitLabelFor(int32 channel) const + \brief Undocumented public method + + \param channel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 *const & BChannelControl::MinLimitList() const + \brief Undocumented protected method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 *const & BChannelControl::MaxLimitList() const + \brief Undocumented protected method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 *const & BChannelControl::ValueList() const + \brief Undocumented protected method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/ChannelSlider.dox b/docs/user/interface/ChannelSlider.dox new file mode 100644 index 0000000000..24677348d5 --- /dev/null +++ b/docs/user/interface/ChannelSlider.dox @@ -0,0 +1,472 @@ +/* + * 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/ChannelSlider.h hrev49977 + * src/kits/interface/ChannelSlider.cpp hrev51468 + */ + + +/*! + \file ChannelSlider.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BChannelSlider + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BChannelSlider::BChannelSlider(BRect area, const char *name, const char *label, BMessage *message, int32 channels=1, uint32 resizeMode=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW) + \brief Undocumented public method + + \param area Undocumented + \param name Undocumented + \param label Undocumented + \param message Undocumented + \param channels Undocumented + \param resizeMode Undocumented + \param flags Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BChannelSlider::BChannelSlider(BRect area, const char *name, const char *label, BMessage *message, orientation orientation, int32 channels=1, uint32 resizeMode=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW) + \brief Undocumented public method + + \param area Undocumented + \param name Undocumented + \param label Undocumented + \param message Undocumented + \param orientation Undocumented + \param channels Undocumented + \param resizeMode Undocumented + \param flags Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BChannelSlider::BChannelSlider(const char *name, const char *label, BMessage *message, orientation orientation, int32 channels=1, uint32 flags=B_WILL_DRAW) + \brief Undocumented public method + + \param name Undocumented + \param label Undocumented + \param message Undocumented + \param orientation Undocumented + \param channels Undocumented + \param flags Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BChannelSlider::BChannelSlider(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BChannelSlider::~BChannelSlider() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelSlider::Archive(BMessage *into, bool deep=true) const + \brief Undocumented public method + + \param into Undocumented + \param deep Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::AttachedToWindow() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::AllAttached() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::DetachedFromWindow() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::AllDetached() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::MessageReceived(BMessage *message) + \brief Undocumented public method + + \param message Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::Draw(BRect updateRect) + \brief Undocumented public method + + \param updateRect Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::MouseDown(BPoint where) + \brief Undocumented public method + + \param where Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::MouseUp(BPoint where) + \brief Undocumented public method + + \param where Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::MouseMoved(BPoint where, uint32 transit, const BMessage *dragMessage) + \brief Undocumented public method + + \param where Undocumented + \param transit Undocumented + \param dragMessage Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::WindowActivated(bool state) + \brief Undocumented public method + + \param state Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::KeyDown(const char *bytes, int32 numBytes) + \brief Undocumented public method + + \param bytes Undocumented + \param numBytes Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::KeyUp(const char *bytes, int32 numBytes) + \brief Undocumented public method + + \param bytes Undocumented + \param numBytes Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::FrameResized(float width, float height) + \brief Undocumented public method + + \param width Undocumented + \param height Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::SetFont(const BFont *font, uint32 mask=B_FONT_ALL) + \brief Undocumented public method + + \param font Undocumented + \param mask Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::MakeFocus(bool focusState=true) + \brief Undocumented public method + + \param focusState Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::GetPreferredSize(float *_width, float *_height) + \brief Undocumented public method + + \param _width Undocumented + \param _height Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BHandler* BChannelSlider::ResolveSpecifier(BMessage *message, int32 index, BMessage *specifier, int32 form, const char *property) + \brief Undocumented public method + + \param message Undocumented + \param index Undocumented + \param specifier Undocumented + \param form Undocumented + \param property Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BChannelSlider::GetSupportedSuites(BMessage *data) + \brief Undocumented public method + + \param data Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::SetEnabled(bool on) + \brief Undocumented public method + + \param on Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual orientation BChannelSlider::Orientation() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BChannelSlider::SetOrientation(orientation orientation) + \brief Undocumented public method + + \param orientation Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual int32 BChannelSlider::MaxChannelCount() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual bool BChannelSlider::SupportsIndividualLimits() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::DrawChannel(BView *into, int32 channel, BRect area, bool pressed) + \brief Undocumented public method + + \param into Undocumented + \param channel Undocumented + \param area Undocumented + \param pressed Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::DrawGroove(BView *into, int32 channel, BPoint leftTop, BPoint rightBottom) + \brief Undocumented public method + + \param into Undocumented + \param channel Undocumented + \param leftTop Undocumented + \param rightBottom Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BChannelSlider::DrawThumb(BView *into, int32 channel, BPoint where, bool pressed) + \brief Undocumented public method + + \param into Undocumented + \param channel Undocumented + \param where Undocumented + \param pressed Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual const BBitmap* BChannelSlider::ThumbFor(int32 channel, bool pressed) + \brief Undocumented public method + + \param channel Undocumented + \param pressed Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BRect BChannelSlider::ThumbFrameFor(int32 channel) + \brief Undocumented public method + + \param channel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual float BChannelSlider::ThumbDeltaFor(int32 channel) + \brief Undocumented public method + + \param channel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual float BChannelSlider::ThumbRangeFor(int32 channel) + \brief Undocumented public method + + \param channel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BChannelSlider::Instantiate(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/Deskbar.dox b/docs/user/interface/Deskbar.dox new file mode 100644 index 0000000000..77cf40d491 --- /dev/null +++ b/docs/user/interface/Deskbar.dox @@ -0,0 +1,395 @@ +/* + * 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/Deskbar.h hrev52499 + * src/kits/interface/Deskbar.cpp hrev52499 + */ + + +/*! + \file Deskbar.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BDeskbar + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BDeskbar::BDeskbar() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BDeskbar::~BDeskbar() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BDeskbar::IsRunning() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BRect BDeskbar::Frame() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn deskbar_location BDeskbar::Location(bool *_isExpanded=NULL) const + \brief Undocumented public method + + \param _isExpanded Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::SetLocation(deskbar_location location, bool expanded=false) + \brief Undocumented public method + + \param location Undocumented + \param expanded Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BDeskbar::IsExpanded() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::Expand(bool expand) + \brief Undocumented public method + + \param expand Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BDeskbar::IsAlwaysOnTop() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::SetAlwaysOnTop(bool alwaysOnTop) + \brief Undocumented public method + + \param alwaysOnTop Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BDeskbar::IsAutoRaise() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::SetAutoRaise(bool autoRaise) + \brief Undocumented public method + + \param autoRaise Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BDeskbar::IsAutoHide() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::SetAutoHide(bool autoHide) + \brief Undocumented public method + + \param autoHide Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::GetItemInfo(int32 id, const char **_name) const + \brief Undocumented public method + + \param id Undocumented + \param _name Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::GetItemInfo(const char *name, int32 *_id) const + \brief Undocumented public method + + \param name Undocumented + \param _id Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BDeskbar::HasItem(int32 id) const + \brief Undocumented public method + + \param id Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BDeskbar::HasItem(const char *name) const + \brief Undocumented public method + + \param name Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn uint32 BDeskbar::CountItems() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BDeskbar::MaxItemWidth() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BDeskbar::MaxItemHeight() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::AddItem(BView *archivableView, int32 *_id=NULL) + \brief Undocumented public method + + \param archivableView Undocumented + \param _id Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::AddItem(entry_ref *addOn, int32 *_id=NULL) + \brief Undocumented public method + + \param addOn Undocumented + \param _id Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::RemoveItem(int32 id) + \brief Undocumented public method + + \param id Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BDeskbar::RemoveItem(const char *name) + \brief Undocumented public method + + \param name Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \enum deskbar_location + \ingroup + \brief Undocumented enum. + + \since Haiku R1 +*/ + + +/*! + \var deskbar_location B_DESKBAR_TOP + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var deskbar_location B_DESKBAR_BOTTOM + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var deskbar_location B_DESKBAR_LEFT_TOP + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var deskbar_location B_DESKBAR_RIGHT_TOP + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var deskbar_location B_DESKBAR_LEFT_BOTTOM + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var deskbar_location B_DESKBAR_RIGHT_BOTTOM + \brief Undocumented enum value. + + \since Haiku R1 +*/ diff --git a/docs/user/interface/GridLayoutBuilder.dox b/docs/user/interface/GridLayoutBuilder.dox new file mode 100644 index 0000000000..049198a2e8 --- /dev/null +++ b/docs/user/interface/GridLayoutBuilder.dox @@ -0,0 +1,207 @@ +/* + * 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/GridLayoutBuilder.h hrev38512 + * src/kits/interface/GridLayoutBuilder.cpp hrev45833 + */ + + +/*! + \file GridLayoutBuilder.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGridLayoutBuilder + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder::BGridLayoutBuilder(float horizontal=B_USE_DEFAULT_SPACING, float vertical=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param horizontal Undocumented + \param vertical Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder::BGridLayoutBuilder(BGridLayout *layout) + \brief Undocumented public method + + \param layout Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder::BGridLayoutBuilder(BGridView *view) + \brief Undocumented public method + + \param view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayout* BGridLayoutBuilder::GridLayout() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder& BGridLayoutBuilder::GetGridLayout(BGridLayout **_layout) + \brief Undocumented public method + + \param _layout Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BView* BGridLayoutBuilder::View() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder& BGridLayoutBuilder::GetView(BView **_view) + \brief Undocumented public method + + \param _view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder& BGridLayoutBuilder::Add(BView *view, int32 column, int32 row, int32 columnCount=1, int32 rowCount=1) + \brief Undocumented public method + + \param view Undocumented + \param column Undocumented + \param row Undocumented + \param columnCount Undocumented + \param rowCount Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder& BGridLayoutBuilder::Add(BLayoutItem *item, int32 column, int32 row, int32 columnCount=1, int32 rowCount=1) + \brief Undocumented public method + + \param item Undocumented + \param column Undocumented + \param row Undocumented + \param columnCount Undocumented + \param rowCount Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder& BGridLayoutBuilder::SetColumnWeight(int32 column, float weight) + \brief Undocumented public method + + \param column Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder& BGridLayoutBuilder::SetRowWeight(int32 row, float weight) + \brief Undocumented public method + + \param row Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder& BGridLayoutBuilder::SetInsets(float left, float top, float right, float bottom) + \brief Undocumented public method + + \param left Undocumented + \param top Undocumented + \param right Undocumented + \param bottom Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayoutBuilder::operator BGridLayout *() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/GridView.dox b/docs/user/interface/GridView.dox new file mode 100644 index 0000000000..a07b991574 --- /dev/null +++ b/docs/user/interface/GridView.dox @@ -0,0 +1,131 @@ +/* + * 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/GridView.h hrev43514 + * src/kits/interface/GridView.cpp hrev49777 + */ + + +/*! + \file GridView.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGridView + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGridView::BGridView(float horizontal=B_USE_DEFAULT_SPACING, float vertical=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param horizontal Undocumented + \param vertical Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridView::BGridView(const char *name, float horizontal=B_USE_DEFAULT_SPACING, float vertical=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param name Undocumented + \param horizontal Undocumented + \param vertical Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridView::BGridView(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BGridView::~BGridView() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BGridView::SetLayout(BLayout *layout) + \brief Undocumented public method + + \param layout Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGridLayout* BGridView::GridLayout() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BGridView::Perform(perform_code d, void *arg) + \brief Undocumented public method + + \param d Undocumented + \param arg Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BGridView::Instantiate(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/GroupLayoutBuilder.dox b/docs/user/interface/GroupLayoutBuilder.dox new file mode 100644 index 0000000000..314275a919 --- /dev/null +++ b/docs/user/interface/GroupLayoutBuilder.dox @@ -0,0 +1,262 @@ +/* + * 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/GroupLayoutBuilder.h hrev45833 + * src/kits//GroupLayoutBuilder.cpp hrev38207 + */ + + +/*! + \file GroupLayoutBuilder.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGroupLayoutBuilder + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder::BGroupLayoutBuilder(orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param orientation Undocumented + \param spacing Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder::BGroupLayoutBuilder(BGroupLayout *layout) + \brief Undocumented public method + + \param layout Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder::BGroupLayoutBuilder(BGroupView *view) + \brief Undocumented public method + + \param view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayout* BGroupLayoutBuilder::RootLayout() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayout* BGroupLayoutBuilder::TopLayout() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::GetTopLayout(BGroupLayout **_layout) + \brief Undocumented public method + + \param _layout Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BView* BGroupLayoutBuilder::TopView() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::GetTopView(BView **_view) + \brief Undocumented public method + + \param _view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BView *view) + \brief Undocumented public method + + \param view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BView *view, float weight) + \brief Undocumented public method + + \param view Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BLayoutItem *item) + \brief Undocumented public method + + \param item Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::Add(BLayoutItem *item, float weight) + \brief Undocumented public method + + \param item Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::AddGroup(orientation orientation, float spacing=B_USE_DEFAULT_SPACING, float weight=1.0f) + \brief Undocumented public method + + \param orientation Undocumented + \param spacing Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::End() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::AddGlue(float weight=1.0f) + \brief Undocumented public method + + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::AddStrut(float size) + \brief Undocumented public method + + \param size Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder& BGroupLayoutBuilder::SetInsets(float left, float top, float right, float bottom) + \brief Undocumented public method + + \param left Undocumented + \param top Undocumented + \param right Undocumented + \param bottom Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayoutBuilder::operator BGroupLayout *() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/GroupView.dox b/docs/user/interface/GroupView.dox new file mode 100644 index 0000000000..362185dbd3 --- /dev/null +++ b/docs/user/interface/GroupView.dox @@ -0,0 +1,131 @@ +/* + * 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/GroupView.h hrev45833 + * src/kits/interface/GroupView.cpp hrev49977 + */ + + +/*! + \file GroupView.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGroupView + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGroupView::BGroupView(orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param orientation Undocumented + \param spacing Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupView::BGroupView(const char *name, orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param name Undocumented + \param orientation Undocumented + \param spacing Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupView::BGroupView(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BGroupView::~BGroupView() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BGroupView::SetLayout(BLayout *layout) + \brief Undocumented public method + + \param layout Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGroupLayout* BGroupView::GroupLayout() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BGroupView::Perform(perform_code d, void *arg) + \brief Undocumented public method + + \param d Undocumented + \param arg Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BGroupView::Instantiate(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/Input.dox b/docs/user/interface/Input.dox new file mode 100644 index 0000000000..4ebd51c27e --- /dev/null +++ b/docs/user/interface/Input.dox @@ -0,0 +1,311 @@ +/* + * 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/Input.h hrev32748 + * src/kits/interface/Input.cpp hrev46376 + */ + + +///// TO THEY WHO DOCUMENT ///// +// The BeBook puts this class and its functions under the category 'Input Server' +// grouped together with BInputServerDevice, BInputServerFilter and BInputServerMethod +// Not sure if we should follow that choice. + +/*! + \file Input.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BInputDevice + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BInputDevice::~BInputDevice() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BInputDevice::Name() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn input_device_type BInputDevice::Type() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BInputDevice::IsRunning() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BInputDevice::Start() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BInputDevice::Stop() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BInputDevice::Control(uint32 code, BMessage *message) + \brief Undocumented public method + + \param code Undocumented + \param message Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static status_t BInputDevice::Start(input_device_type type) + \brief Undocumented public method + + \param type Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static status_t BInputDevice::Stop(input_device_type type) + \brief Undocumented public method + + \param type Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static status_t BInputDevice::Control(input_device_type type, uint32 code, BMessage *message) + \brief Undocumented public method + + \param type Undocumented + \param code Undocumented + \param message Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \enum input_method_op + \ingroup + \brief Undocumented enum. + + \since Haiku R1 +*/ + + +/*! + \var input_method_op B_INPUT_METHOD_STARTED + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_method_op B_INPUT_METHOD_STOPPED + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_method_op B_INPUT_METHOD_CHANGED + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_method_op B_INPUT_METHOD_LOCATION_REQUEST + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \enum input_device_type + \ingroup + \brief Undocumented enum. + + \since Haiku R1 +*/ + + +/*! + \var input_device_type B_POINTING_DEVICE + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_device_type B_KEYBOARD_DEVICE + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_device_type B_UNDEFINED_DEVICE + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \enum input_device_notification + \ingroup + \brief Undocumented enum. + + \since Haiku R1 +*/ + + +/*! + \var input_device_notification B_INPUT_DEVICE_ADDED + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_device_notification B_INPUT_DEVICE_STARTED + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_device_notification B_INPUT_DEVICE_STOPPED + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var input_device_notification B_INPUT_DEVICE_REMOVED + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \fn BInputDevice* find_input_device(const char *name) + \brief Undocumented function + + \param name Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t get_input_devices(BList *list) + \brief Undocumented function + + \param list Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t watch_input_devices(BMessenger target, bool start) + \brief Undocumented function + + \param target Undocumented + \param start Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/OptionControl.dox b/docs/user/interface/OptionControl.dox new file mode 100644 index 0000000000..f4e7e16d36 --- /dev/null +++ b/docs/user/interface/OptionControl.dox @@ -0,0 +1,214 @@ +/* + * 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/OptionControl.h hrev49977 + * src/kits/interface/OptionControl.cpp hrev33756 + */ + + +///// TO THEY WHO DOCUMENT: it seems like the OptionControl.cpp file some docs already, so that's a good starting point ///// + + +/*! + \file OptionControl.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BOptionControl + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BOptionControl::BOptionControl(BRect frame, const char *name, const char *label, BMessage *message, uint32 resizeMask=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW) + \brief Undocumented public method + + \param frame Undocumented + \param name Undocumented + \param label Undocumented + \param message Undocumented + \param resizeMask Undocumented + \param flags Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BOptionControl::BOptionControl(const char *name, const char *label, BMessage *message, uint32 flags=B_WILL_DRAW) + \brief Undocumented public method + + \param name Undocumented + \param label Undocumented + \param message Undocumented + \param flags Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BOptionControl::~BOptionControl() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BOptionControl::MessageReceived(BMessage *message) + \brief Undocumented public method + + \param message Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BOptionControl::AddOption(const char *name, int32 value) + \brief Undocumented public method + + \param name Undocumented + \param value Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual bool BOptionControl::GetOptionAt(int32 index, const char **_name, int32 *_value)=0 + \brief Undocumented public method + + \param index Undocumented + \param _name Undocumented + \param _value Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual void BOptionControl::RemoveOptionAt(int32 index)=0 + \brief Undocumented public method + + \param index Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual int32 BOptionControl::CountOptions() const =0 + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual status_t BOptionControl::AddOptionAt(const char *name, int32 value, int32 index)=0 + \brief Undocumented public method + + \param name Undocumented + \param value Undocumented + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual int32 BOptionControl::SelectedOption(const char **name=NULL, int32 *outValue=NULL) const =0 + \brief Undocumented public method + + \param name Undocumented + \param outValue Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BOptionControl::SelectOptionFor(int32 value) + \brief Undocumented public method + + \param value Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BOptionControl::SelectOptionFor(const char *name) + \brief Undocumented public method + + \param name Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BMessage* BOptionControl::MakeValueMessage(int32 value) + \brief Undocumented protected method + + \param value Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \var B_OPTION_CONTROL_VALUE + \brief Undocumented enum value. + + \since Haiku R1 +*/ diff --git a/docs/user/interface/SeparatorView.dox b/docs/user/interface/SeparatorView.dox new file mode 100644 index 0000000000..27ac783c64 --- /dev/null +++ b/docs/user/interface/SeparatorView.dox @@ -0,0 +1,288 @@ +/* + * 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/SeparatorView.h hrev45833 + * src/kits/interface/SeparatorView.cpp hrev53246 + */ + + +/*! + \file SeparatorView.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BSeparatorView + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BSeparatorView::BSeparatorView(orientation orientation, border_style border=B_PLAIN_BORDER) + \brief Undocumented public method + + \param orientation Undocumented + \param border Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSeparatorView::BSeparatorView(const char *name, const char *label, orientation orientation=B_HORIZONTAL, border_style border=B_FANCY_BORDER, const BAlignment &alignment=BAlignment(B_ALIGN_HORIZONTAL_CENTER, B_ALIGN_VERTICAL_CENTER)) + \brief Undocumented public method + + \param name Undocumented + \param label Undocumented + \param orientation Undocumented + \param border Undocumented + \param alignment Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSeparatorView::BSeparatorView(const char *name, BView *labelView, orientation orientation=B_HORIZONTAL, border_style border=B_FANCY_BORDER, const BAlignment &alignment=BAlignment(B_ALIGN_HORIZONTAL_CENTER, B_ALIGN_VERTICAL_CENTER)) + \brief Undocumented public method + + \param name Undocumented + \param labelView Undocumented + \param orientation Undocumented + \param border Undocumented + \param alignment Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSeparatorView::BSeparatorView(const char *label=NULL, orientation orientation=B_HORIZONTAL, border_style border=B_FANCY_BORDER, const BAlignment &alignment=BAlignment(B_ALIGN_HORIZONTAL_CENTER, B_ALIGN_VERTICAL_CENTER)) + \brief Undocumented public method + + \param label Undocumented + \param orientation Undocumented + \param border Undocumented + \param alignment Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSeparatorView::BSeparatorView(BView *labelView, orientation orientation=B_HORIZONTAL, border_style border=B_FANCY_BORDER, const BAlignment &alignment=BAlignment(B_ALIGN_HORIZONTAL_CENTER, B_ALIGN_VERTICAL_CENTER)) + \brief Undocumented public method + + \param labelView Undocumented + \param orientation Undocumented + \param border Undocumented + \param alignment Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSeparatorView::BSeparatorView(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSeparatorView::~BSeparatorView() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BSeparatorView::Archive(BMessage *into, bool deep=true) const + \brief Undocumented public method + + \param into Undocumented + \param deep Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSeparatorView::Draw(BRect updateRect) + \brief Undocumented public method + + \param updateRect Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSeparatorView::GetPreferredSize(float *width, float *height) + \brief Undocumented public method + + \param width Undocumented + \param height Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BSeparatorView::MinSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BSeparatorView::MaxSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BSeparatorView::PreferredSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSeparatorView::SetOrientation(orientation orientation) + \brief Undocumented public method + + \param orientation Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSeparatorView::SetAlignment(const BAlignment &aligment) + \brief Undocumented public method + + \param aligment Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSeparatorView::SetBorderStyle(border_style border) + \brief Undocumented public method + + \param border Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSeparatorView::SetLabel(const char *label) + \brief Undocumented public method + + \param label Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSeparatorView::SetLabel(BView *view, bool deletePrevious) + \brief Undocumented public method + + \param view Undocumented + \param deletePrevious Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BSeparatorView::Perform(perform_code code, void *data) + \brief Undocumented public method + + \param code Undocumented + \param data Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BSeparatorView::Instantiate(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSeparatorView::DoLayout() + \brief Undocumented protected method + + \since Haiku R1 +*/ diff --git a/docs/user/interface/SpaceLayoutItem.dox b/docs/user/interface/SpaceLayoutItem.dox new file mode 100644 index 0000000000..8d04256294 --- /dev/null +++ b/docs/user/interface/SpaceLayoutItem.dox @@ -0,0 +1,260 @@ +/* + * 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/SpaceLayoutItem.h hrev43514 + * src/kits/interface/SpaceLayoutItem.cpp hrev44346 + */ + + +/*! + \file SpaceLayoutItem.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BSpaceLayoutItem + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BSpaceLayoutItem::BSpaceLayoutItem(BSize minSize, BSize maxSize, BSize preferredSize, BAlignment alignment) + \brief Undocumented public method + + \param minSize Undocumented + \param maxSize Undocumented + \param preferredSize Undocumented + \param alignment Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSpaceLayoutItem::BSpaceLayoutItem(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSpaceLayoutItem::~BSpaceLayoutItem() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BSpaceLayoutItem::MinSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BSpaceLayoutItem::MaxSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BSpaceLayoutItem::PreferredSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BAlignment BSpaceLayoutItem::Alignment() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSpaceLayoutItem::SetExplicitMinSize(BSize size) + \brief Undocumented public method + + \param size Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSpaceLayoutItem::SetExplicitMaxSize(BSize size) + \brief Undocumented public method + + \param size Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSpaceLayoutItem::SetExplicitPreferredSize(BSize size) + \brief Undocumented public method + + \param size Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSpaceLayoutItem::SetExplicitAlignment(BAlignment alignment) + \brief Undocumented public method + + \param alignment Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual bool BSpaceLayoutItem::IsVisible() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSpaceLayoutItem::SetVisible(bool visible) + \brief Undocumented public method + + \param visible Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BRect BSpaceLayoutItem::Frame() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSpaceLayoutItem::SetFrame(BRect frame) + \brief Undocumented public method + + \param frame Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BSpaceLayoutItem::Archive(BMessage *into, bool deep=true) const + \brief Undocumented public method + + \param into Undocumented + \param deep Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BSpaceLayoutItem* BSpaceLayoutItem::CreateGlue() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BSpaceLayoutItem* BSpaceLayoutItem::CreateHorizontalStrut(float width) + \brief Undocumented public method + + \param width Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BSpaceLayoutItem* BSpaceLayoutItem::CreateVerticalStrut(float height) + \brief Undocumented public method + + \param height Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BSpaceLayoutItem::Instantiate(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/SplitLayoutBuilder.dox b/docs/user/interface/SplitLayoutBuilder.dox new file mode 100644 index 0000000000..1298aa528c --- /dev/null +++ b/docs/user/interface/SplitLayoutBuilder.dox @@ -0,0 +1,175 @@ +/* + * 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/SplitLayoutBuilder.h hrev45833 + * src/kits/interface/SplitLayoutBuilder.cpp hrev45833 + */ + + +/*! + \file SplitLayoutBuilder.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BSplitLayoutBuilder + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder::BSplitLayoutBuilder(orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param orientation Undocumented + \param spacing Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder::BSplitLayoutBuilder(BSplitView *view) + \brief Undocumented public method + + \param view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitView* BSplitLayoutBuilder::SplitView() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder& BSplitLayoutBuilder::GetSplitView(BSplitView **view) + \brief Undocumented public method + + \param view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder& BSplitLayoutBuilder::Add(BView *view) + \brief Undocumented public method + + \param view Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder& BSplitLayoutBuilder::Add(BView *view, float weight) + \brief Undocumented public method + + \param view Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder& BSplitLayoutBuilder::Add(BLayoutItem *item) + \brief Undocumented public method + + \param item Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder& BSplitLayoutBuilder::Add(BLayoutItem *item, float weight) + \brief Undocumented public method + + \param item Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder& BSplitLayoutBuilder::SetCollapsible(bool collapsible) + \brief Undocumented public method + + \param collapsible Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder& BSplitLayoutBuilder::SetInsets(float left, float top, float right, float bottom) + \brief Undocumented public method + + \param left Undocumented + \param top Undocumented + \param right Undocumented + \param bottom Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitLayoutBuilder::operator BSplitView *() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/SplitView.dox b/docs/user/interface/SplitView.dox new file mode 100644 index 0000000000..f037276caa --- /dev/null +++ b/docs/user/interface/SplitView.dox @@ -0,0 +1,550 @@ +/* + * 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/SplitView.h hrev49977 + * src/kits/interface/SplitView.cpp hrev43279 + */ + + +/*! + \file SplitView.h + \ingroup layout + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BSplitView + \ingroup layout + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BSplitView::BSplitView(orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING) + \brief Undocumented public method + + \param orientation Undocumented + \param spacing Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BSplitView::BSplitView(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSplitView::~BSplitView() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetInsets(float left, float top, float right, float bottom) + \brief Undocumented public method + + \param left Undocumented + \param top Undocumented + \param right Undocumented + \param bottom Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetInsets(float horizontal, float vertical) + \brief Undocumented public method + + \param horizontal Undocumented + \param vertical Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetInsets(float insets) + \brief Undocumented public method + + \param insets Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::GetInsets(float *left, float *top, float *right, float *bottom) const + \brief Undocumented public method + + \param left Undocumented + \param top Undocumented + \param right Undocumented + \param bottom Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BSplitView::Spacing() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetSpacing(float spacing) + \brief Undocumented public method + + \param spacing Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn orientation BSplitView::Orientation() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetOrientation(orientation orientation) + \brief Undocumented public method + + \param orientation Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BSplitView::SplitterSize() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetSplitterSize(float size) + \brief Undocumented public method + + \param size Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BSplitView::CountItems() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BSplitView::ItemWeight(int32 index) const + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BSplitView::ItemWeight(BLayoutItem *item) const + \brief Undocumented public method + + \param item Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetItemWeight(int32 index, float weight, bool invalidateLayout) + \brief Undocumented public method + + \param index Undocumented + \param weight Undocumented + \param invalidateLayout Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetItemWeight(BLayoutItem *item, float weight) + \brief Undocumented public method + + \param item Undocumented + \param weight Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BSplitView::IsCollapsible(int32 index) const + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetCollapsible(bool collapsible) + \brief Undocumented public method + + \param collapsible Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetCollapsible(int32 index, bool collapsible) + \brief Undocumented public method + + \param index Undocumented + \param collapsible Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetCollapsible(int32 first, int32 last, bool collapsible) + \brief Undocumented public method + + \param first Undocumented + \param last Undocumented + \param collapsible Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BSplitView::IsItemCollapsed(int32 index) const + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::SetItemCollapsed(int32 index, bool collapsed) + \brief Undocumented public method + + \param index Undocumented + \param collapsed Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BSplitView::AddChild(BView *child, BView *sibling=NULL) + \brief Undocumented public method + + \param child Undocumented + \param sibling Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BSplitView::AddChild(BView *child, float weight) + \brief Undocumented public method + + \param child Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BSplitView::AddChild(int32 index, BView *child, float weight) + \brief Undocumented public method + + \param index Undocumented + \param child Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BSplitView::AddChild(BLayoutItem *child) + \brief Undocumented public method + + \param child Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BSplitView::AddChild(BLayoutItem *child, float weight) + \brief Undocumented public method + + \param child Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BSplitView::AddChild(int32 index, BLayoutItem *child, float weight) + \brief Undocumented public method + + \param index Undocumented + \param child Undocumented + \param weight Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::AttachedToWindow() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::Draw(BRect updateRect) + \brief Undocumented public method + + \param updateRect Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::DrawAfterChildren(BRect updateRect) + \brief Undocumented public method + + \param updateRect Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::MouseDown(BPoint where) + \brief Undocumented public method + + \param where Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::MouseUp(BPoint where) + \brief Undocumented public method + + \param where Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::MouseMoved(BPoint where, uint32 transit, const BMessage *message) + \brief Undocumented public method + + \param where Undocumented + \param transit Undocumented + \param message Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::MessageReceived(BMessage *message) + \brief Undocumented public method + + \param message Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::SetLayout(BLayout *layout) + \brief Undocumented public method + + \param layout Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BSplitView::Archive(BMessage *into, bool deep=true) const + \brief Undocumented public method + + \param into Undocumented + \param deep Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BSplitView::Perform(perform_code d, void *arg) + \brief Undocumented public method + + \param d Undocumented + \param arg Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BSplitView::Instantiate(BMessage *from) + \brief Undocumented public method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BSplitView::AllArchived(BMessage *into) const + \brief Undocumented protected method + + \param into Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BSplitView::AllUnarchived(const BMessage *from) + \brief Undocumented protected method + + \param from Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BSplitView::DrawSplitter(BRect frame, const BRect &updateRect, orientation orientation, bool pressed) + \brief Undocumented protected method + + \param frame Undocumented + \param updateRect Undocumented + \param orientation Undocumented + \param pressed Undocumented + + \since Haiku R1 +*/ diff --git a/docs/user/interface/StatusBar.dox b/docs/user/interface/StatusBar.dox new file mode 100644 index 0000000000..7a6df80994 --- /dev/null +++ b/docs/user/interface/StatusBar.dox @@ -0,0 +1,506 @@ +/* + * 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/StatusBar.h hrev49977 + * src/kits/interface/StatusBar.cpp hrev51409 + */ + + +/*! + \file StatusBar.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BStatusBar + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BStatusBar::BStatusBar(BRect frame, const char *name, const char *label=NULL, const char *trailingLabel=NULL) + \brief Undocumented public method + + \param frame Undocumented + \param name Undocumented + \param label Undocumented + \param trailingLabel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BStatusBar::BStatusBar(const char *name, const char *label=NULL, const char *trailingLabel=NULL) + \brief Undocumented public method + + \param name Undocumented + \param label Undocumented + \param trailingLabel Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BStatusBar::BStatusBar(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BStatusBar::~BStatusBar() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BStatusBar::Archive(BMessage *archive, bool deep=true) const + \brief Undocumented public method + + \param archive Undocumented + \param deep Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::AttachedToWindow() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::DetachedFromWindow() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::AllAttached() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::AllDetached() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::WindowActivated(bool state) + \brief Undocumented public method + + \param state Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::MakeFocus(bool focus=true) + \brief Undocumented public method + + \param focus Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::GetPreferredSize(float *_width, float *_height) + \brief Undocumented public method + + \param _width Undocumented + \param _height Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BStatusBar::MinSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BStatusBar::MaxSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BSize BStatusBar::PreferredSize() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::ResizeToPreferred() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::FrameMoved(BPoint newPosition) + \brief Undocumented public method + + \param newPosition Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::FrameResized(float newWidth, float newHeight) + \brief Undocumented public method + + \param newWidth Undocumented + \param newHeight Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::Draw(BRect updateRect) + \brief Undocumented public method + + \param updateRect Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::MessageReceived(BMessage *message) + \brief Undocumented public method + + \param message Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::MouseDown(BPoint where) + \brief Undocumented public method + + \param where Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::MouseUp(BPoint where) + \brief Undocumented public method + + \param where Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::MouseMoved(BPoint where, uint32 transit, const BMessage *dragMessage) + \brief Undocumented public method + + \param where Undocumented + \param transit Undocumented + \param dragMessage Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::SetBarColor(rgb_color color) + \brief Undocumented public method + + \param color Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::SetBarHeight(float height) + \brief Undocumented public method + + \param height Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::SetText(const char *string) + \brief Undocumented public method + + \param string Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::SetTrailingText(const char *string) + \brief Undocumented public method + + \param string Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::SetMaxValue(float max) + \brief Undocumented public method + + \param max Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::Update(float delta, const char *text=NULL, const char *trailingText=NULL) + \brief Undocumented public method + + \param delta Undocumented + \param text Undocumented + \param trailingText Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::Reset(const char *label=NULL, const char *trailingLabel=NULL) + \brief Undocumented public method + + \param label Undocumented + \param trailingLabel Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual void BStatusBar::SetTo(float value, const char *text=NULL, const char *trailingText=NULL) + \brief Undocumented public method + + \param value Undocumented + \param text Undocumented + \param trailingText Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BStatusBar::CurrentValue() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BStatusBar::MaxValue() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn rgb_color BStatusBar::BarColor() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BStatusBar::BarHeight() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BStatusBar::Text() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BStatusBar::TrailingText() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BStatusBar::Label() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn const char* BStatusBar::TrailingLabel() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual BHandler* BStatusBar::ResolveSpecifier(BMessage *message, int32 index, BMessage *specifier, int32 what, const char *property) + \brief Undocumented public method + + \param message Undocumented + \param index Undocumented + \param specifier Undocumented + \param what Undocumented + \param property Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BStatusBar::GetSupportedSuites(BMessage *data) + \brief Undocumented public method + + \param data Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual virtual status_t BStatusBar::Perform(perform_code d, void *arg) + \brief Undocumented public method + + \param d Undocumented + \param arg Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn static static BArchivable* BStatusBar::Instantiate(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/