File indexing completed on 2024-12-22 04:13:14

 /*
  *  SPDX-FileCopyrightText: 2013 Juan Palacios <jpalaciosdev@gmail.com>
  *
  * SPDX-License-Identifier: LGPL-2.0-or-later
  */
 
 #ifndef KISSIZEGROUP_H
 #define KISSIZEGROUP_H
 
 #include <QObject>
 #include "kritaui_export.h"
 
 class QWidget;
 class KisSizeGroupPrivate;
 
 /**
  * KisSizeGroup provides a mechanism to group widgets together so they all
  * request the same amount of space. Also, the widgets will share the same
  * amount of minimum space. The mode of KisSizeGroup determines the direction of
  * the space that are affected by the size group.
  *
  * All widgets inside of KisSizeGroup will use the same size hint value, computed
  * as the maximum of all of his size hint values. The same value is used for the
  * minimum size of all widgets. When KisSizeGroup ignore hidden widgets, the
  * size of widgets that are not visible don't count in the computation of the
  * current size value. When one of these widgets becomes visible again, a new
  * size value is computed and applied to all visible widgets.
  *
  * KisSizeGroup cannot share the same widget with other size groups, so one
  * widget can be in one, and only one, KisSizeGroup at time.
  *
  * NOTE: Added widgets in size groups must be laid out inside of a valid
  * layout. The current implementation supports widgets laid out inside of
  * QGridLayout, QFormLayout and QBoxLayout. If the parent widget layout is not
  * one of them, then the group size will not affect the widget size.
  */
 class KRITAUI_EXPORT KisSizeGroup : public QObject
 {
     Q_OBJECT
 
 public:
     /**
      * Determines the direction in which the size group affects the requested
      * and minimum sizes of his component widgets.
      */
     enum mode
     {
         KIS_SIZE_GROUP_NONE = 0,                                                 //! group has no effect
         KIS_SIZE_GROUP_HORIZONTAL = 1 << 0,                                      //! group affects horizontal size
         KIS_SIZE_GROUP_VERTICAL = 1 << 1,                                        //! group affects vertical size
         KIS_SIZE_GROUP_BOTH = (KIS_SIZE_GROUP_HORIZONTAL | KIS_SIZE_GROUP_VERTICAL)//! group affects horizontal and vertical size
     };
 
     /**
      * Creates a new size group.
      *
      * By default, the mode of the size group is KIS_SIZE_GROUP_HORIZONTAL and
      * the group will not ignore hidden widgets.
      */
     explicit KisSizeGroup(QObject* parent = 0,
                          KisSizeGroup::mode mode = KisSizeGroup::KIS_SIZE_GROUP_HORIZONTAL,
                          bool ignoreHidden = false);
 
     ~KisSizeGroup() override;
 
     /// Changes the group size mode.
     void setMode(KisSizeGroup::mode mode);
 
     /// Returns the current mode of the group size.
     KisSizeGroup::mode getMode() const;
 
     /// Sets whether the group will ignore not visible widgets
     void setIgnoreHidden(bool ignoreHidden);
 
     /// Returns whether the group ignores not visible widgets
     bool isIgnoreHidden() const;
 
     /// Adds a new widget to the group.
     /// WARNING: adding the same widget to multiple size groups is not supported!
     void addWidget(QWidget *widget);
 
     /// Removes a widget from the size group.
     void removeWidget(QWidget *widget);
 
 private:
     KisSizeGroupPrivate* const d;
 };
 
 #endif // KISSIZEGROUP_H