ClanLib  2.3.7
List of all members
CL_ListViewColumnHeader Class Reference

ListView column header class. More...

#include <listview_column_header.h>

Public Member Functions

Construction
 CL_ListViewColumnHeader ()
 
 ~CL_ListViewColumnHeader ()
 
Operations
void set_alignment (CL_ListViewColumnHeader::TextAlignment align)
 Set alignment. More...
 
void set_width (int width)
 Set width. More...
 
void set_caption (const CL_StringRef &str)
 Set caption. More...
 
void set_column_id (const CL_StringRef &str)
 Set column id. More...
 
Events
CL_Callback_v1
< CL_ListViewColumnHeader > & 
func_size_changed ()
 

Attributes

enum  TextAlignment { align_left, align_right, align_center }
 
bool is_null () const
 Returns true if this object is invalid. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
CL_StringRef get_column_id () const
 Get Column id. More...
 
CL_StringRef get_caption () const
 Get Caption. More...
 
int get_width ()
 Get Width. More...
 
int get_used_width ()
 Returns the used width (last column expanded to the rest of the list view) More...
 
CL_ListViewColumnHeader::TextAlignment get_alignment ()
 
CL_ListViewColumnHeader get_next_sibling ()
 Get Next sibling. More...
 
CL_ListViewColumnHeader get_prev_sibling ()
 Get Prev sibling. More...
 

Implementation

class CL_ListView_Impl
 
class CL_ListViewHeader
 
class CL_ListViewHeader_Impl
 

Detailed Description

ListView column header class.

Member Enumeration Documentation

Enumerator
align_left 
align_right 
align_center 

Constructor & Destructor Documentation

CL_ListViewColumnHeader::CL_ListViewColumnHeader ( )
CL_ListViewColumnHeader::~CL_ListViewColumnHeader ( )

Member Function Documentation

CL_Callback_v1<CL_ListViewColumnHeader>& CL_ListViewColumnHeader::func_size_changed ( )
CL_ListViewColumnHeader::TextAlignment CL_ListViewColumnHeader::get_alignment ( )
CL_StringRef CL_ListViewColumnHeader::get_caption ( ) const

Get Caption.

Returns
caption
CL_StringRef CL_ListViewColumnHeader::get_column_id ( ) const

Get Column id.

Returns
column_id
CL_ListViewColumnHeader CL_ListViewColumnHeader::get_next_sibling ( )

Get Next sibling.

Returns
next_sibling
CL_ListViewColumnHeader CL_ListViewColumnHeader::get_prev_sibling ( )

Get Prev sibling.

Returns
prev_sibling
int CL_ListViewColumnHeader::get_used_width ( )

Returns the used width (last column expanded to the rest of the list view)

Returns
width
int CL_ListViewColumnHeader::get_width ( )

Get Width.

Returns
width
bool CL_ListViewColumnHeader::is_null ( ) const
inline

Returns true if this object is invalid.

void CL_ListViewColumnHeader::set_alignment ( CL_ListViewColumnHeader::TextAlignment  align)

Set alignment.

Parameters
TextAlignment= List View Column Header
void CL_ListViewColumnHeader::set_caption ( const CL_StringRef str)

Set caption.

Parameters
str= String Ref
void CL_ListViewColumnHeader::set_column_id ( const CL_StringRef str)

Set column id.

Parameters
str= String Ref
void CL_ListViewColumnHeader::set_width ( int  width)

Set width.

Parameters
width= value
void CL_ListViewColumnHeader::throw_if_null ( ) const

Throw an exception if this object is invalid.

Friends And Related Function Documentation

friend class CL_ListView_Impl
friend
friend class CL_ListViewHeader
friend
friend class CL_ListViewHeader_Impl
friend

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