1 /*=========================================================================
2 
3   Library:   CTK
4 
5   Copyright (c) Kitware Inc.
6 
7   Licensed under the Apache License, Version 2.0 (the "License");
8   you may not use this file except in compliance with the License.
9   You may obtain a copy of the License at
10 
11       http://www.apache.org/licenses/LICENSE-2.0.txt
12 
13   Unless required by applicable law or agreed to in writing, software
14   distributed under the License is distributed on an "AS IS" BASIS,
15   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   See the License for the specific language governing permissions and
17   limitations under the License.
18 
19 =========================================================================*/
20 
21 #ifndef __ctkDynamicSpacer_h
22 #define __ctkDynamicSpacer_h
23 
24 // Qt includes
25 #include <QWidget>
26 
27 // CTK includes
28 #include <ctkPimpl.h>
29 #include "ctkWidgetsExport.h"
30 
31 class ctkDynamicSpacerPrivate;
32 
33 /// \ingroup Widgets
34 /// Description
35 /// A spacer widget that has a dynamic size policy controllable via its slot
36 /// activate(bool). It can be usefully when you don't want a rigid layout.
37 class CTK_WIDGETS_EXPORT ctkDynamicSpacer : public QWidget
38 {
39   Q_OBJECT
40   Q_PROPERTY(QSizePolicy activeSizePolicy READ activeSizePolicy WRITE setActiveSizePolicy);
41   Q_PROPERTY(QSizePolicy inactiveSizePolicy READ inactiveSizePolicy WRITE setInactiveSizePolicy);
42   Q_PROPERTY(bool active READ isActive WRITE setActive);
43 public:
44   /// Constructor, builds a ctkDynamicSpacer, inactive by default
45   ctkDynamicSpacer(QWidget *parent = 0);
46   virtual ~ctkDynamicSpacer();
47 
48   /// The active size policy of the spacer. By default the same as QWidget
49   QSizePolicy activeSizePolicy() const;
50   void setActiveSizePolicy(QSizePolicy sizePolicy);
51   inline void setActiveSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical);
52 
53   /// The inactive size policy of the spacer. By default the same as QWidget.
54   QSizePolicy inactiveSizePolicy() const;
55   void setInactiveSizePolicy(QSizePolicy sizePolicy);
56   inline void setInactiveSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical);
57 
58   /// Return the what size policy is current:
59   /// false is inactive Size Policy that is current
60   /// true is active SizePolicy that is current
61   bool isActive()const;
62   inline bool isInactive()const;
63 
64 public Q_SLOTS:
65   /// Change the size policy. If enable is true, activeSizePolicy is used,
66   /// inactiveSizePolicy otherwise
67   void setActive(bool enable);
68   inline void setInactive(bool disable);
69 
70 protected:
71   QScopedPointer<ctkDynamicSpacerPrivate> d_ptr;
72 
73 private:
74   Q_DECLARE_PRIVATE(ctkDynamicSpacer);
75   Q_DISABLE_COPY(ctkDynamicSpacer);
76 };
77 
setActiveSizePolicy(QSizePolicy::Policy horizontal,QSizePolicy::Policy vertical)78 void ctkDynamicSpacer::setActiveSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
79 {
80   this->setActiveSizePolicy(QSizePolicy(horizontal, vertical));
81 }
82 
setInactiveSizePolicy(QSizePolicy::Policy horizontal,QSizePolicy::Policy vertical)83 void ctkDynamicSpacer::setInactiveSizePolicy(QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
84 {
85   this->setInactiveSizePolicy(QSizePolicy(horizontal, vertical));
86 }
87 
isInactive()88 bool ctkDynamicSpacer::isInactive()const
89 {
90   return !this->isActive();
91 }
92 
setInactive(bool disable)93 void ctkDynamicSpacer::setInactive(bool disable)
94 {
95   this->setActive(!disable);
96 }
97 
98 #endif
99