Nana C++ Library. Reference for users.
What we need to use nana
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
nana::drawerbase::listbox::column_interface Class Referenceabstract

An interface of column operations. More...

Inheritance diagram for nana::drawerbase::listbox::column_interface:
nana::drawerbase::listbox::es_header::column

Public Member Functions

virtual ~column_interface ()=default
 
virtual unsigned width () const noexcept=0
 Returns the width of the column, in pixel. More...
 
virtual void width (unsigned pixels) noexcept=0
 Sets width. More...
 
virtual void width (unsigned minimum, unsigned maximum)=0
 Automatically adjusted width. More...
 
virtual size_type position (bool disp_order) const noexcept=0
 Returns the position of the column. More...
 
virtual std::string text () const noexcept=0
 Returns the caption of column. More...
 
virtual void text (std::string text_utf8)=0
 Sets the caption of column. More...
 
virtual void text_align (::nana::align align) noexcept=0
 Sets alignment of column text. More...
 
virtual void fit_content (unsigned maximum=0) noexcept=0
 Adjusts the width to fit the content. More...
 
virtual void typeface (const paint::font &column_font)=0
 Sets an exclusive font for the column. More...
 
virtual paint::font typeface () const noexcept=0
 Returns a font. More...
 
virtual bool visible () const noexcept=0
 Determines the visibility state of the column. More...
 
virtual void visible (bool is_visible) noexcept=0
 Sets the visibility state of the column. More...
 

Detailed Description

An interface of column operations.

Constructor & Destructor Documentation

virtual nana::drawerbase::listbox::column_interface::~column_interface ( )
virtualdefault

Member Function Documentation

virtual void nana::drawerbase::listbox::column_interface::fit_content ( unsigned  maximum = 0)
pure virtualnoexcept

Adjusts the width to fit the content.

The priority of max: maximum, ranged width, scheme's max_fit_content.

Parameters
maximumSets the width of column to the maximum if the width of content is larger than maximum

Implemented in nana::drawerbase::listbox::es_header::column.

virtual size_type nana::drawerbase::listbox::column_interface::position ( bool  disp_order) const
pure virtualnoexcept

Returns the position of the column.

Parameters
disp_orderIndicates whether the display position or absolute position to be returned
Returns
the position of the column.

Implemented in nana::drawerbase::listbox::es_header::column.

virtual std::string nana::drawerbase::listbox::column_interface::text ( ) const
pure virtualnoexcept

Returns the caption of column.

Implemented in nana::drawerbase::listbox::es_header::column.

virtual void nana::drawerbase::listbox::column_interface::text ( std::string  text_utf8)
pure virtual

Sets the caption of column.

Parameters
text_utf8A UTF-8 string for the caption.

Implemented in nana::drawerbase::listbox::es_header::column.

virtual void nana::drawerbase::listbox::column_interface::text_align ( ::nana::align  align)
pure virtualnoexcept

Sets alignment of column text.

Parameters
alignAlignment

Implemented in nana::drawerbase::listbox::es_header::column.

virtual void nana::drawerbase::listbox::column_interface::typeface ( const paint::font column_font)
pure virtual

Sets an exclusive font for the column.

Implemented in nana::drawerbase::listbox::es_header::column.

virtual paint::font nana::drawerbase::listbox::column_interface::typeface ( ) const
pure virtualnoexcept

Returns a font.

Implemented in nana::drawerbase::listbox::es_header::column.

virtual bool nana::drawerbase::listbox::column_interface::visible ( ) const
pure virtualnoexcept

Determines the visibility state of the column.

Returns
true if the column is visible, false otherwise

Implemented in nana::drawerbase::listbox::es_header::column.

virtual void nana::drawerbase::listbox::column_interface::visible ( bool  is_visible)
pure virtualnoexcept

Sets the visibility state of the column.

Parameters
is_visibleIndicates whether to show or hide the column

Implemented in nana::drawerbase::listbox::es_header::column.

virtual unsigned nana::drawerbase::listbox::column_interface::width ( ) const
pure virtualnoexcept

Returns the width of the column, in pixel.

Implemented in nana::drawerbase::listbox::es_header::column.

virtual void nana::drawerbase::listbox::column_interface::width ( unsigned  pixels)
pure virtualnoexcept

Sets width.

Parameters
pixelsThe pixels of width

Implemented in nana::drawerbase::listbox::es_header::column.

virtual void nana::drawerbase::listbox::column_interface::width ( unsigned  minimum,
unsigned  maximum 
)
pure virtual

Automatically adjusted width.

Parameters
minimumThe minimal width of column, in pixel
maximumThe maximal width of column, in pixel

Implemented in nana::drawerbase::listbox::es_header::column.