/usr/include/Wt/WBoxLayout is in libwt-dev 3.3.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WBOX_LAYOUT_H_
#define WBOX_LAYOUT_H_
#include <Wt/WGridLayout>
namespace Wt {
/*! \class WBoxLayout Wt/WBoxLayout Wt/WBoxLayout
* \brief A layout manager which arranges widgets horizontally or vertically
*
* This layout manager arranges widgets horizontally or vertically
* inside the parent container.
*
* The space is divided so that each widget is given its preferred
* size, and remaining space is divided according to stretch factors
* among widgets. If not all widgets can be given their preferred size
* (there is not enough room), then widgets are given a smaller size
* (down to their minimum size). If necessary, the container (or
* parent layout) of this layout is resized to meet minimum size
* requirements.
*
* The preferred width or height of a widget is based on its natural
* size, where it presents its contents without
* overflowing. WWidget::resize() or (CSS <tt>width</tt>,
* <tt>height</tt> properties) can be used to adjust the preferred
* size of a widget.
*
* The minimum width or height of a widget is based on the minimum
* dimensions of the widget or the nested layout. The default minimum
* height or width for a widget is 0. It can be specified using
* WWidget::setMinimumSize() or using CSS <tt>min-width</tt> or
* <tt>min-height</tt> properties.
*
* You should use \link WContainerWidget::setOverflow()
* WContainerWidget::setOverflow(OverflowAuto) \endlink or use a
* WScrollArea to automatically show scrollbars for widgets inserted
* in the layout to cope with a size set by the layout manager that is
* smaller than the preferred size.
*
* When the container of a layout manager has a maximum size set using
* WWidget::setMaximumSize(), then the size of the container will be
* based on the preferred size of the contents, up to this maximum
* size, instead of the default behaviour of constraining the size of
* the children based on the size of the container.
*
* A layout manager may provide resize handles between items which
* allow the user to change the automatic layout provided by the
* layout manager (see setResizable()).
*
* Each item is separated using a constant spacing, which defaults to
* 6 pixels, and can be changed using setSpacing(). In addition, when
* this layout is a top-level layout (i.e. is not nested inside
* another layout), a margin is set around the contents. This margin
* defaults to 9 pixels, and can be changed using
* setContentsMargins(). You can add more space between two widgets
* using addSpacing().
*
* For each item a stretch factor may be defined, which controls how
* remaining space is used. Each item is stretched using the stretch
* factor to fill the remaining space.
*
* \if cpp
* Usage example:
* \code
* Wt::WContainerWidget *w = new Wt::WContainerWidget(this);
* w->resize(WLength(), 600);
*
* Wt::WBoxLayout *layout = new Wt::WBoxLayout(Wt::WBoxLayout::TopToBottom);
* layout->addWidget(new Wt::WText("One"));
* layout->addWidget(new Wt::WText("Two"));
* layout->addWidget(new Wt::WText("Three"));
* layout->addWidget(new Wt::WText("Four"));
*
* w->setLayout(layout);
* \endcode
* \endif
*
* \if cpp
* \note This layout manager is applicable only to WContainerWidget
* container widgets. You may use it within an Ext::Container
* indirectly by first setting a WContainerWidget using a WFitLayout.
* \endif
*
* \note When JavaScript support is not available, not all functionality
* of the layout is available. In particular, vertical size management is
* not available.
*
* \note When a layout is used on a first page with progressive
* bootstrap, then the layout will progress only in a limited way to a
* full JavaScript-based layout. You can thus not rely on it to behave
* properly for example when dynamically adding or removing widgets.
*/
class WT_API WBoxLayout : public WLayout
{
public:
/*! \brief Enumeration of the direction in which widgets are layed out.
*/
enum Direction {
LeftToRight, //!< Horizontal layout, widgets are arranged from left to right
RightToLeft, //!< Horizontal layout, widgets are arranged from right to left
TopToBottom, //!< Vertical layout, widgets are arranged from top to bottom
BottomToTop //!< Vertical layout, widgets are arranged from bottom to top
};
/*! \brief Creates a new box layout.
*
* This constructor is rarely used. Instead, use the convenient
* constructors of the specialized WHBoxLayout or WVBoxLayout classes.
*
* Use \p parent = \c 0 to created a layout manager that can be
* nested inside other layout managers.
*/
WBoxLayout(Direction dir, WWidget *parent = 0);
virtual void addItem(WLayoutItem *item);
virtual void removeItem(WLayoutItem *item);
virtual WLayoutItem *itemAt(int index) const;
virtual int count() const;
virtual void clear();
/*! \brief Sets the layout direction.
*
* \sa direction()
*/
void setDirection(Direction direction);
/*! \brief Returns the layout direction.
*
* \sa setDirection()
*/
Direction direction() const { return direction_; }
/*! \brief Sets spacing between each item.
*
* The default spacing is 6 pixels.
*/
void setSpacing(int size);
/*! \brief Returns the spacing between each item.
*
* \sa setSpacing()
*/
int spacing() const { return grid_.horizontalSpacing_; }
/*! \brief Adds a widget to the layout.
*
* Adds a widget to the layout, with given \p stretch factor. When
* the stretch factor is 0, the widget will not be resized by the
* layout manager (stretched to take excess space).
*
* The \p alignment parameter is a combination of a horizontal
* and/or a vertical AlignmentFlag OR'ed together.
*
* The \p alignment specifies the vertical and horizontal
* alignment of the item. The default value 0 indicates that the
* item is stretched to fill the entire column or row. The alignment can
* be specified as a logical combination of a horizontal alignment
* (Wt::AlignLeft, Wt::AlignCenter, or Wt::AlignRight) and a
* vertical alignment (Wt::AlignTop, Wt::AlignMiddle, or
* Wt::AlignBottom).
*
* \sa addLayout(), insertWidget()
*/
void addWidget(WWidget *widget, int stretch = 0,
WFlags<AlignmentFlag> alignment = 0);
/*! \brief Adds a nested layout to the layout.
*
* Adds a nested layout, with given \p stretch factor.
*
* \sa addWidget(WWidget *, int, WFlags<AlignmentFlag>), insertLayout()
*/
void addLayout(WLayout *layout, int stretch = 0,
WFlags<AlignmentFlag> alignment = 0);
/*! \brief Adds extra spacing.
*
* Adds extra spacing to the layout.
*
* \sa addStretch(), insertStretch()
*/
void addSpacing(const WLength& size);
/*! \brief Adds a stretch element.
*
* Adds a stretch element to the layout. This adds an empty space
* that stretches as needed.
*
* \sa addSpacing(), insertStretch()
*/
void addStretch(int stretch = 0);
/*! \brief Inserts a widget in the layout.
*
* Inserts a widget in the layout at position \p index, with given
* \p stretch factor. When the stretch factor is 0, the widget will
* not be resized by the layout manager (stretched to take excess
* space).
*
* The \p alignment specifies the vertical and horizontal
* alignment of the item. The default value 0 indicates that the
* item is stretched to fill the entire column or row. The alignment can
* be specified as a logical combination of a horizontal alignment
* (Wt::AlignLeft, Wt::AlignCenter, or Wt::AlignRight) and a
* vertical alignment (Wt::AlignTop, Wt::AlignMiddle, or
* Wt::AlignBottom).
*
* \sa insertLayout(), addWidget(WWidget *, int, WFlags<AlignmentFlag>)
*/
void insertWidget(int index, WWidget *widget, int stretch = 0,
WFlags<AlignmentFlag> alignment = 0);
/*! \brief Inserts a nested layout in the layout.
*
* Inserts a nested layout in the layout at position\p index,
* with given \p stretch factor.
*
* \sa insertWidget(), addLayout()
*/
void insertLayout(int index, WLayout *layout, int stretch = 0,
WFlags<AlignmentFlag> alignment = 0);
/*! \brief Inserts extra spacing in the layout.
*
* Inserts extra spacing in the layout at position \p index.
*
* \sa insertStretch(), addSpacing()
*/
void insertSpacing(int index, const WLength& size);
/*! \brief Inserts a stretch element in the layout.
*
* Inserts a stretch element in the layout at position
* \p index. This adds an empty space that stretches as needed.
*
* \sa insertSpacing(), addStretch()
*/
void insertStretch(int index, int stretch = 0);
/*! \brief Sets the stretch factor for a nested layout.
*
* The \p layout must have previously been added to this layout
* using insertLayout() or addLayout().
*
* Returns whether the \p stretch could be set.
*/
bool setStretchFactor(WLayout *layout, int stretch);
/*! \brief Sets the stretch factor for a widget.
*
* The \p widget must have previously been added to this layout
* using insertWidget() or addWidget().
*
* Returns whether the \p stretch could be set.
*/
bool setStretchFactor(WWidget *widget, int stretch);
/*! \brief Sets whether the use may drag a particular border.
*
* This method sets whether the border that separates item
* <i>index</i> from the next item may be resized by the user,
* depending on the value of <i>enabled</i>.
*
* The default value is <i>false</i>.
*
* If an \p initialSize is given (that is not WLength::Auto), then
* this size is used for the size of the item, overriding the size
* it would be given by the layout manager.
*/
void setResizable(int index, bool enabled = true,
const WLength& initialSize = WLength::Auto);
/*! \brief Returns whether the user may drag a particular border.
*
* This method returns whether the border that separates item
* <i>index</i> from the next item may be resized by the user.
*
* \sa setResizable()
*/
bool isResizable(int index) const;
Impl::Grid& grid() { return grid_; }
protected:
void insertItem(int index, WLayoutItem *item, int stretch,
WFlags<AlignmentFlag> alignment);
private:
Direction direction_;
Impl::Grid grid_;
void setStretchFactor(int index, int stretch);
WWidget *createSpacer(const WLength& size);
};
}
#endif // WBOX_LAYOUT_H_
|