LibreOffice Module toolkit (master) 1
Public Member Functions | List of all members
svt::table::IColumnModel Class Referenceabstract

interface to be implemented by table column models More...

#include <tablemodel.hxx>

Inheritance diagram for svt::table::IColumnModel:
[legend]

Public Member Functions

virtual OUString getName () const =0
 returns the name of the column More...
 
virtual OUString getHelpText () const =0
 retrieves the help text to be displayed for the column. More...
 
virtual bool isResizable () const =0
 determines whether the column can be interactively resized More...
 
virtual sal_Int32 getFlexibility () const =0
 denotes the relative flexibility of the column More...
 
virtual TableMetrics getWidth () const =0
 returns the width of the column, in app-font units More...
 
virtual void setWidth (TableMetrics _nWidth)=0
 sets a new width for the column More...
 
virtual TableMetrics getMinWidth () const =0
 returns the minimum width of the column, in app-font units, or 0 if the column does not have a minimal width More...
 
virtual TableMetrics getMaxWidth () const =0
 returns the maximum width of the column, in app-font units, or 0 if the column does not have a minimal width More...
 
virtual css::style::HorizontalAlignment getHorizontalAlign ()=0
 retrieves the horizontal alignment to be used for content in this cell More...
 
virtual ~IColumnModel ()
 deletes the column model instance More...
 

Detailed Description

interface to be implemented by table column models

Definition at line 157 of file tablemodel.hxx.

Constructor & Destructor Documentation

◆ ~IColumnModel()

virtual svt::table::IColumnModel::~IColumnModel ( )
inlinevirtual

deletes the column model instance

Definition at line 232 of file tablemodel.hxx.

Member Function Documentation

◆ getFlexibility()

virtual sal_Int32 svt::table::IColumnModel::getFlexibility ( ) const
pure virtual

denotes the relative flexibility of the column

This flexibility is taken into account when a table control auto-resizes its columns, because the available space changed. In this case, the columns grow or shrink according to their flexibility.

A value of 0 means the column is not auto-resized at all.

Implemented in svt::table::UnoGridColumnFacade.

◆ getHelpText()

virtual OUString svt::table::IColumnModel::getHelpText ( ) const
pure virtual

retrieves the help text to be displayed for the column.

Implemented in svt::table::UnoGridColumnFacade.

◆ getHorizontalAlign()

virtual css::style::HorizontalAlignment svt::table::IColumnModel::getHorizontalAlign ( )
pure virtual

retrieves the horizontal alignment to be used for content in this cell

Implemented in svt::table::UnoGridColumnFacade.

◆ getMaxWidth()

virtual TableMetrics svt::table::IColumnModel::getMaxWidth ( ) const
pure virtual

returns the maximum width of the column, in app-font units, or 0 if the column does not have a minimal width

See also
setMaxWidth
getMinWidth
getWidth

Implemented in svt::table::UnoGridColumnFacade.

◆ getMinWidth()

virtual TableMetrics svt::table::IColumnModel::getMinWidth ( ) const
pure virtual

returns the minimum width of the column, in app-font units, or 0 if the column does not have a minimal width

See also
setMinWidth
getMaxWidth
getWidth

Implemented in svt::table::UnoGridColumnFacade.

◆ getName()

virtual OUString svt::table::IColumnModel::getName ( ) const
pure virtual

returns the name of the column

Column names should be human-readable, but not necessarily unique within a given table.

See also
setName

Implemented in svt::table::UnoGridColumnFacade.

◆ getWidth()

virtual TableMetrics svt::table::IColumnModel::getWidth ( ) const
pure virtual

returns the width of the column, in app-font units

The returned value must be a positive ->TableMetrics value.

See also
setWidth
getMinWidth
getMaxWidth

Implemented in svt::table::UnoGridColumnFacade.

◆ isResizable()

virtual bool svt::table::IColumnModel::isResizable ( ) const
pure virtual

determines whether the column can be interactively resized

See also
getMinWidth
getMaxWidth
getWidth

Implemented in svt::table::UnoGridColumnFacade.

◆ setWidth()

virtual void svt::table::IColumnModel::setWidth ( TableMetrics  _nWidth)
pure virtual

sets a new width for the column

Parameters
_nWidththe new width, app-font units
See also
getWidth

Implemented in svt::table::UnoGridColumnFacade.


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