File indexing completed on 2024-05-12 04:44:36

 // SPDX-FileCopyrightText: Lukas Sommer <sommerluk@gmail.com>
 // SPDX-License-Identifier: BSD-2-Clause OR MIT
 
 #ifndef SWATCHBOOK_P_H
 #define SWATCHBOOK_P_H
 
 // Include the header of the public class of this private implementation.
 // #include "swatchbook.h"
 
 #include "constpropagatingrawpointer.h"
 #include "helper.h"
 #include "helperqttypes.h"
 #include <qcolor.h>
 #include <qglobal.h>
 #include <qnamespace.h>
 #include <qobject.h>
 #include <qpoint.h>
 #include <qsharedpointer.h>
 #include <qsize.h>
 #include <qstring.h>
 #include <qstyleoption.h>
 
 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
 #include <qtmetamacros.h>
 #else
 #include <qobjectdefs.h>
 #endif
 
 namespace PerceptualColor
 {
 class SwatchBook;
 class RgbColorSpace;
 
 /** @internal
  *
  *  @brief Private implementation within the <em>Pointer to
  *  implementation</em> idiom */
 class SwatchBookPrivate final : public QObject
 {
     Q_OBJECT
 
 public:
     explicit SwatchBookPrivate(SwatchBook *backLink, const Array2D<QColor> &swatches, Qt::Orientations wideSpacing);
     /** @brief Default destructor
      *
      * The destructor is non-<tt>virtual</tt> because
      * the class as a whole is <tt>final</tt>. */
     ~SwatchBookPrivate() noexcept override = default;
 
     [[nodiscard]] QSize colorPatchesSizeWithMargin() const;
     [[nodiscard]] int horizontalPatchSpacing() const;
     void initStyleOption(QStyleOptionFrame *option) const;
     [[nodiscard]] int normalPatchSpacing() const;
     [[nodiscard]] QPoint offset(const QStyleOptionFrame &styleOptionFrame) const;
     [[nodiscard]] QSize patchSizeInner() const;
     [[nodiscard]] QSize patchSizeOuter() const;
     void retranslateUi();
     void selectSwatch(QListSizeType newCurrentColomn, QListSizeType newCurrentRow);
     [[nodiscard]] int verticalPatchSpacing() const;
     [[nodiscard]] int widePatchSpacing() const;
 
     /** @brief Internal storage for property @ref SwatchBook::currentColor
      *
      * QColor automatically initializes with an invalid color, just like it
      * should be for the property @ref SwatchBook::currentColor, so no
      * need to initialize here explicitly. */
     QColor m_currentColor;
     /** @brief Pointer to the RgbColorSpace object. */
     QSharedPointer<PerceptualColor::RgbColorSpace> m_rgbColorSpace;
     /** @brief Selected column.
      *
      * If one of the swatches in the book is selected, this is
      * the index of the column.
      * Otherwise, its <tt>-1</tt>. */
     QListSizeType m_selectedColumn = -1;
     /** @brief Selected row.
      *
      * If one of the swatches in the book is selected, this is
      * the index of the row.
      * Otherwise, its <tt>-1</tt>. */
     QListSizeType m_selectedRow = -1;
     /** @brief The selection mark to use, or an empty string if no
      * selection mark is available.
      *
      * The selection mark is drawn above the patch that is currently selected.
      *
      * This variable contains the localized selection mark string (if all its
      * characters are) available in the default font of this widget. An
      * empty string otherwise.
      *
      * The value is set by @ref retranslateUi(). */
     QString m_selectionMark;
     /** @brief The colors of the swatches.
      *
      * This is a two-dimensional array. At the first level the
      * basic color (red, green…). At the second level, a particular
      * tint/shade of this basic color.
      *
      * @sa @ref m_selectedColumn
      * @sa @ref m_selectedRow */
     const Array2D<QColor> m_swatches;
     /** @brief List of axis where @ref widePatchSpacing should be used. */
     const Qt::Orientations m_wideSpacing;
 
 private:
     Q_DISABLE_COPY(SwatchBookPrivate)
 
     /** @brief Pointer to the object from which <em>this</em> object
      *  is the private implementation. */
     ConstPropagatingRawPointer<SwatchBook> q_pointer;
 };
 
 } // namespace PerceptualColor
 
 #endif // SWATCHBOOK_P_H