From f125de8cc8c18fae444a5caa22f1be6c191142e0 Mon Sep 17 00:00:00 2001 From: Niels Sascha Reedijk Date: Mon, 19 Apr 2021 06:56:16 +0100 Subject: [PATCH] HaikuBook: Add internal skeletons for BGradient* classes Change-Id: I9b75084550dc510692122994a102ccd9923ed987 --- docs/user/interface/Gradient.dox | 591 ++++++++++++++++++++ docs/user/interface/GradientConic.dox | 129 +++++ docs/user/interface/GradientDiamond.dox | 105 ++++ docs/user/interface/GradientLinear.dox | 140 +++++ docs/user/interface/GradientRadial.dox | 128 +++++ docs/user/interface/GradientRadialFocus.dox | 163 ++++++ 6 files changed, 1256 insertions(+) create mode 100644 docs/user/interface/Gradient.dox create mode 100644 docs/user/interface/GradientConic.dox create mode 100644 docs/user/interface/GradientDiamond.dox create mode 100644 docs/user/interface/GradientLinear.dox create mode 100644 docs/user/interface/GradientRadial.dox create mode 100644 docs/user/interface/GradientRadialFocus.dox diff --git a/docs/user/interface/Gradient.dox b/docs/user/interface/Gradient.dox new file mode 100644 index 0000000000..53a889b2c3 --- /dev/null +++ b/docs/user/interface/Gradient.dox @@ -0,0 +1,591 @@ +/* + * Copyright 2020 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/interface/Gradient.h hrev54502 + * src/kits/interface/Gradient.cpp hrev54502 + */ + + +//! \cond INTERNAL + + +/*! + \file Gradient.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGradient + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \struct BGradient::ColorStop + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \var rgb_color BGradient::ColorStop::color + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var float BGradient::ColorStop::offset + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop(const ColorStop &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop(const rgb_color c, float o) + \brief Undocumented public method + + \param c Undocumented + \param o Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop(uint8 r, uint8 g, uint8 b, uint8 a, + float o) + \brief Undocumented public method + + \param r Undocumented + \param g Undocumented + \param b Undocumented + \param a Undocumented + \param o Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::ColorStop::operator!=(const ColorStop &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \enum BGradient::Type + \brief Undocumented enum. + + \since Haiku R1 +*/ + + +/*! + \var Type BGradient::TYPE_LINEAR + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var Type BGradient::TYPE_RADIAL + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var Type BGradient::TYPE_RADIAL_FOCUS + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var Type BGradient::TYPE_DIAMOND + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var Type BGradient::TYPE_CONIC + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \var Type BGradient::TYPE_NONE + \brief Undocumented enum value. + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::BGradient() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::BGradient(BMessage *archive) + \brief Undocumented public method + + \param archive Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::BGradient(const BGradient &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual BGradient::~BGradient() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BGradient::AddColor(const rgb_color &color, float offset) + \brief Undocumented public method + + \param color Undocumented + \param offset Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::AddColorStop(const ColorStop &colorStop, int32 index) + \brief Undocumented public method + + \param colorStop Undocumented + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn virtual status_t BGradient::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 ColorStop* BGradient::ColorStopAt(int32 index) const + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn ColorStop* BGradient::ColorStopAtFast(int32 index) const + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn ColorStop* BGradient::ColorStops() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::ColorStopsAreEqual(const BGradient &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn int32 BGradient::CountColorStops() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn status_t BGradient::Flatten(BDataIO *stream) const + \brief Undocumented public method + + \param stream Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn Type BGradient::GetType() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradient::MakeEmpty() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::operator!=(const BGradient &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient& BGradient::operator=(const BGradient &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::operator==(const BGradient &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::RemoveColor(int32 index) + \brief Undocumented public method + + \param index Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::SetColor(int32 index, const rgb_color &color) + \brief Undocumented public method + + \param index Undocumented + \param color Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::SetColorStop(int32 index, const ColorStop &colorStop) + \brief Undocumented public method + + \param index Undocumented + \param colorStop Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradient::SetColorStops(const BGradient &other) + \brief Undocumented public method + + \param other Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::SetOffset(int32 index, float offset) + \brief Undocumented public method + + \param index Undocumented + \param offset Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradient::SortColorStopsByOffset() + \brief Undocumented public method + + \since Haiku R1 +*/ + + +/*! + \fn static status_t BGradient::Unflatten(BGradient *&output, + BDataIO *stream) + \brief Undocumented public method + + \param output Undocumented + \param stream Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \struct BGradient::ColorStop + \ingroup + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \var rgb_color BGradient::ColorStop::color + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \var float BGradient::ColorStop::offset + \brief Undocumented public variable + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop(const ColorStop &other) + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop(const rgb_color c, float o) + \brief Undocumented public method + + \param c Undocumented + \param o Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradient::ColorStop::ColorStop(uint8 r, uint8 g, uint8 b, uint8 a, + float o) + \brief Undocumented public method + + \param r Undocumented + \param g Undocumented + \param b Undocumented + \param a Undocumented + \param o Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn bool BGradient::ColorStop::operator!=(const ColorStop &other) const + \brief Undocumented public method + + \param other Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +//! \endcond INTERNAL diff --git a/docs/user/interface/GradientConic.dox b/docs/user/interface/GradientConic.dox new file mode 100644 index 0000000000..2cba6a9071 --- /dev/null +++ b/docs/user/interface/GradientConic.dox @@ -0,0 +1,129 @@ +/* + * Copyright 2020 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/interface/GradientConic.h hrev32745 + * src/kits/interface/GradientConic.cpp hrev28560 + */ + + +//! \cond INTERNAL + + +/*! + \file GradientConic.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGradientConic + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGradientConic::BGradientConic() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientConic::BGradientConic(const BPoint ¢er, float angle) + \brief Undocumented public method + + \param center Undocumented + \param angle Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientConic::BGradientConic(float cx, float cy, float angle) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + \param angle Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BGradientConic::Angle() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BGradientConic::Center() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientConic::SetAngle(float angle) + \brief Undocumented public method + + \param angle Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientConic::SetCenter(const BPoint ¢er) + \brief Undocumented public method + + \param center Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientConic::SetCenter(float cx, float cy) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + + \since Haiku R1 +*/ + + +//! \endcond INTERNAL diff --git a/docs/user/interface/GradientDiamond.dox b/docs/user/interface/GradientDiamond.dox new file mode 100644 index 0000000000..2a4e0116d4 --- /dev/null +++ b/docs/user/interface/GradientDiamond.dox @@ -0,0 +1,105 @@ +/* + * Copyright 2020 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/interface/GradientDiamond.h hrev32745 + * src/kits/interface/GradientDiamond.cpp hrev28564 + */ + + +//! \cond INTERNAL + + +/*! + \file GradientDiamond.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGradientDiamond + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGradientDiamond::BGradientDiamond() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientDiamond::BGradientDiamond(const BPoint ¢er) + \brief Undocumented public method + + \param center Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientDiamond::BGradientDiamond(float cx, float cy) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BGradientDiamond::Center() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientDiamond::SetCenter(const BPoint ¢er) + \brief Undocumented public method + + \param center Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientDiamond::SetCenter(float cx, float cy) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + + \since Haiku R1 +*/ + +//! \endcond INTERNAL diff --git a/docs/user/interface/GradientLinear.dox b/docs/user/interface/GradientLinear.dox new file mode 100644 index 0000000000..cf6c98a3e0 --- /dev/null +++ b/docs/user/interface/GradientLinear.dox @@ -0,0 +1,140 @@ +/* + * Copyright 2020 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/interface/GradientLinear.h hrev32745 + * src/kits/interface/GradientLinear.cpp hrev28564 + */ + + +//! \cond INTERNAL + + +/*! + \file GradientLinear.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGradientLinear + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGradientLinear::BGradientLinear() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientLinear::BGradientLinear(const BPoint &start, const BPoint &end) + \brief Undocumented public method + + \param start Undocumented + \param end Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientLinear::BGradientLinear(float x1, float y1, float x2, float y2) + \brief Undocumented public method + + \param x1 Undocumented + \param y1 Undocumented + \param x2 Undocumented + \param y2 Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BGradientLinear::End() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientLinear::SetEnd(const BPoint &end) + \brief Undocumented public method + + \param end Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientLinear::SetEnd(float x2, float y2) + \brief Undocumented public method + + \param x2 Undocumented + \param y2 Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientLinear::SetStart(const BPoint &start) + \brief Undocumented public method + + \param start Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientLinear::SetStart(float x1, float y1) + \brief Undocumented public method + + \param x1 Undocumented + \param y1 Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BGradientLinear::Start() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + +//! \endcond INTERNAL diff --git a/docs/user/interface/GradientRadial.dox b/docs/user/interface/GradientRadial.dox new file mode 100644 index 0000000000..b4d7ab82d5 --- /dev/null +++ b/docs/user/interface/GradientRadial.dox @@ -0,0 +1,128 @@ +/* + * Copyright 2020 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/interface/GradientLinear.h hrev32745 + * src/kits/interface/GradientLinear.cpp hrev28564 + */ + + +//! \cond INTERNAL + + +/*! + \file GradientRadial.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGradientRadial + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGradientRadial::BGradientRadial() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientRadial::BGradientRadial(const BPoint ¢er, float radius) + \brief Undocumented public method + + \param center Undocumented + \param radius Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientRadial::BGradientRadial(float cx, float cy, float radius) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + \param radius Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BGradientRadial::Center() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BGradientRadial::Radius() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadial::SetCenter(const BPoint ¢er) + \brief Undocumented public method + + \param center Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadial::SetCenter(float cx, float cy) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadial::SetRadius(float radius) + \brief Undocumented public method + + \param radius Undocumented + + \since Haiku R1 +*/ + +//! \endcond INTERNAL diff --git a/docs/user/interface/GradientRadialFocus.dox b/docs/user/interface/GradientRadialFocus.dox new file mode 100644 index 0000000000..409f1098f8 --- /dev/null +++ b/docs/user/interface/GradientRadialFocus.dox @@ -0,0 +1,163 @@ +/* + * Copyright 2020 Haiku, Inc. All rights reserved. + * Distributed under the terms of the MIT License. + * + * Authors: + * Name, email@email.com + * + * Corresponds to: + * headers/os/interface/GradientLinear.h hrev32745 + * src/kits/interface/GradientLinear.cpp hrev28564 + */ + + +//! \cond INTERNAL + + +/*! + \file GradientRadialFocus.h + \ingroup interface + \brief Undocumented file. + + \since Haiku R1 +*/ + + +/*! + \class BGradientRadialFocus + \ingroup interface + \ingroup libbe + \brief Undocumented class. + + \since Haiku R1 +*/ + + +/*! + \fn BGradientRadialFocus::BGradientRadialFocus() + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientRadialFocus::BGradientRadialFocus(const BPoint ¢er, float radius, const BPoint &focal) + \brief Undocumented public method + + \param center Undocumented + \param radius Undocumented + \param focal Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BGradientRadialFocus::BGradientRadialFocus(float cx, float cy, float radius, float fx, float fy) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + \param radius Undocumented + \param fx Undocumented + \param fy Undocumented + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BGradientRadialFocus::Center() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn BPoint BGradientRadialFocus::Focal() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn float BGradientRadialFocus::Radius() const + \brief Undocumented public method + + \return Undocumented + \retval Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadialFocus::SetCenter(const BPoint ¢er) + \brief Undocumented public method + + \param center Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadialFocus::SetCenter(float cx, float cy) + \brief Undocumented public method + + \param cx Undocumented + \param cy Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadialFocus::SetFocal(const BPoint &focal) + \brief Undocumented public method + + \param focal Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadialFocus::SetFocal(float fx, float fy) + \brief Undocumented public method + + \param fx Undocumented + \param fy Undocumented + + \since Haiku R1 +*/ + + +/*! + \fn void BGradientRadialFocus::SetRadius(float radius) + \brief Undocumented public method + + \param radius Undocumented + + \since Haiku R1 +*/ + +//! \endcond INTERNAL