cwidget  0.5.17
Public Types | Public Member Functions | Public Attributes | List of all members
cwidget::fragment_column_entry Struct Reference

Stores information on a single column of fragments. More...

#include <fragment.h>

Public Types

enum  align { top, center, bottom }
 

Public Member Functions

 fragment_column_entry (bool _proportional, bool _expandable, size_t _width, align _vert_align, fragment *f)
 Create a fragment column that has a single line. More...
 
 fragment_column_entry (bool _proportional, bool _expandable, size_t _width, align _vert_align, const std::vector< fragment *> &_lines)
 

Public Attributes

bool proportional
 If true, this column is allocated space proportionally; otherwise, its width is exactly what is specified.
 
bool expandable
 If proportional is false and the fragment is not NULL, then setting this to true means that the width below will be expanded to max_width if necessary. More...
 
size_t width
 If proportional is true, this is a number giving the relative size of this column compared to other proportional columns; otherwise, this is the width of the column in character cells.
 
align vert_align
 The vertical alignment of the column. More...
 
std::vector< fragment * > lines
 The vertical components of this column. More...
 

Detailed Description

Stores information on a single column of fragments.

Constructor & Destructor Documentation

◆ fragment_column_entry()

cwidget::fragment_column_entry::fragment_column_entry ( bool  _proportional,
bool  _expandable,
size_t  _width,
align  _vert_align,
fragment f 
)
inline

Create a fragment column that has a single line.

References cwidget::fragf().

Member Data Documentation

◆ expandable

bool cwidget::fragment_column_entry::expandable

If proportional is false and the fragment is not NULL, then setting this to true means that the width below will be expanded to max_width if necessary.

If the resulting fragment exceeds the screen width, it will be shrunk as necessary.

Referenced by cwidget::dropbox().

◆ lines

std::vector<fragment *> cwidget::fragment_column_entry::lines

The vertical components of this column.

Each vertical entry in the column will begin on the same line as the corresponding vertical entries in the other columns. If not all columns have the same number of vertical entries, the shorter columns are padded with blank lines to be the same length as the longer columns.

NULL entries produce blank lines.

Referenced by cwidget::dropbox().

◆ vert_align

align cwidget::fragment_column_entry::vert_align

The vertical alignment of the column.

If top, the top of this column is placed at the top of the fragment. If center, the center of this column is aligned with the center of the fragment. And if bottom, the bottom of this column is aligned with the bottom of the fragment.


The documentation for this struct was generated from the following file: