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::es_header Class Reference

Classes

struct  attributes
 
struct  column
 

Public Types

using container = std::vector< column >
 

Public Member Functions

export_options::columns_indexs get_headers (bool only_visibles) const
 
std::string to_string (const export_options &exp_opt) const
 
const attributesattrib () const noexcept
 
attributesattrib () noexcept
 
size_type create (essence *ess, native_string_type &&text, unsigned pixels)
 
void clear ()
 
unsigned width_px () const noexcept
 < the visible width of the whole header More...
 
bool calc_ranged_columns (unsigned width) noexcept
 Calculates the ranged columns to make the whole header fit a specified width. More...
 
const containercont () const noexcept
 
size_type cast (size_type pos, bool disp_order) const
 
columnat (size_type pos, bool disp_order=false)
 find and return a ref to the column that originally was at position "pos" previous to any list reorganization. More...
 
const columnat (size_type pos, bool disp_order=false) const
 
size_type column_from_point (int x) const noexcept
 Returns the position(original index when it is creating) of the current column at point x. More...
 
unsigned margin () const
 
std::pair< int, unsigned > range (size_type pos) const
 
size_type next (size_type index) const noexcept
 return the original index of the visible col currently before(in front of) or after the col originally at index "index" More...
 
size_type boundary (bool get_front) const noexcept
 Returns the absolute position of the first/last visible column. More...
 
void move_to_view_pos (size_type col, size_type view, bool front) noexcept
 move col to view pos More...
 
void move (size_type from, size_type to, bool front) noexcept
 move the col originally at "from" to the position currently in front (or after) the col originally at index "to" invalidating some current index More...
 

Member Typedef Documentation

Member Function Documentation

column& nana::drawerbase::listbox::es_header::at ( size_type  pos,
bool  disp_order = false 
)
inline

find and return a ref to the column that originally was at position "pos" previous to any list reorganization.

It always match the item with pos, otherwise a bug occurs.

const column& nana::drawerbase::listbox::es_header::at ( size_type  pos,
bool  disp_order = false 
) const
inline
const attributes& nana::drawerbase::listbox::es_header::attrib ( ) const
inlinenoexcept
attributes& nana::drawerbase::listbox::es_header::attrib ( )
inlinenoexcept
size_type nana::drawerbase::listbox::es_header::boundary ( bool  get_front) const
inlinenoexcept

Returns the absolute position of the first/last visible column.

bool nana::drawerbase::listbox::es_header::calc_ranged_columns ( unsigned  width)
inlinenoexcept

Calculates the ranged columns to make the whole header fit a specified width.

Parameters
widthThe width to be fittd
Returns
true if the ranged columns is adjusted for the width, false otherwise.
size_type nana::drawerbase::listbox::es_header::cast ( size_type  pos,
bool  disp_order 
) const
inline
void nana::drawerbase::listbox::es_header::clear ( )
inline
size_type nana::drawerbase::listbox::es_header::column_from_point ( int  x) const
inlinenoexcept

Returns the position(original index when it is creating) of the current column at point x.

const container& nana::drawerbase::listbox::es_header::cont ( ) const
inlinenoexcept
size_type nana::drawerbase::listbox::es_header::create ( essence ess,
native_string_type &&  text,
unsigned  pixels 
)
inline
export_options::columns_indexs nana::drawerbase::listbox::es_header::get_headers ( bool  only_visibles) const
inline
unsigned nana::drawerbase::listbox::es_header::margin ( ) const
inline
void nana::drawerbase::listbox::es_header::move ( size_type  from,
size_type  to,
bool  front 
)
inlinenoexcept

move the col originally at "from" to the position currently in front (or after) the col originally at index "to" invalidating some current index

void nana::drawerbase::listbox::es_header::move_to_view_pos ( size_type  col,
size_type  view,
bool  front 
)
inlinenoexcept

move col to view pos

size_type nana::drawerbase::listbox::es_header::next ( size_type  index) const
inlinenoexcept

return the original index of the visible col currently before(in front of) or after the col originally at index "index"

std::pair<int, unsigned> nana::drawerbase::listbox::es_header::range ( size_type  pos) const
inline
std::string nana::drawerbase::listbox::es_header::to_string ( const export_options exp_opt) const
inline
unsigned nana::drawerbase::listbox::es_header::width_px ( ) const
inlinenoexcept

< the visible width of the whole header