LibreOffice Module toolkit (master) 1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
svt::table::UnoGridColumnFacade Class Reference

#include <unogridcolumnfacade.hxx>

Inheritance diagram for svt::table::UnoGridColumnFacade:
[legend]
Collaboration diagram for svt::table::UnoGridColumnFacade:
[legend]

Public Member Functions

 UnoGridColumnFacade (UnoControlTableModel const &i_owner, css::uno::Reference< css::awt::grid::XGridColumn > const &i_gridColumn)
 
virtual ~UnoGridColumnFacade () override
 
 UnoGridColumnFacade (const UnoGridColumnFacade &)=delete
 
UnoGridColumnFacadeoperator= (const UnoGridColumnFacade &)=delete
 
virtual OUString getName () const override
 returns the name of the column More...
 
virtual OUString getHelpText () const override
 retrieves the help text to be displayed for the column. More...
 
virtual bool isResizable () const override
 determines whether the column can be interactively resized More...
 
virtual sal_Int32 getFlexibility () const override
 denotes the relative flexibility of the column More...
 
virtual TableMetrics getWidth () const override
 returns the width of the column, in app-font units More...
 
virtual void setWidth (TableMetrics _nWidth) override
 sets a new width for the column More...
 
virtual TableMetrics getMinWidth () const override
 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 override
 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 () override
 retrieves the horizontal alignment to be used for content in this cell More...
 
void dispose ()
 disposes the column wrapper More...
 
sal_Int32 getDataColumnIndex () const
 
void columnChanged (ColumnAttributeGroup const i_attributeGroup)
 
void dataColumnIndexChanged ()
 
- Public Member Functions inherited from svt::table::IColumnModel
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...
 

Private Member Functions

void impl_updateDataColumnIndex_nothrow ()
 

Private Attributes

UnoControlTableModel const * m_pOwner
 
sal_Int32 m_nDataColumnIndex
 
css::uno::Reference< css::awt::grid::XGridColumn > m_xGridColumn
 
::rtl::Reference< ColumnChangeMultiplexerm_pChangeMultiplexer
 

Detailed Description

Definition at line 38 of file unogridcolumnfacade.hxx.

Constructor & Destructor Documentation

◆ UnoGridColumnFacade() [1/2]

svt::table::UnoGridColumnFacade::UnoGridColumnFacade ( UnoControlTableModel const &  i_owner,
css::uno::Reference< css::awt::grid::XGridColumn > const &  i_gridColumn 
)

◆ ~UnoGridColumnFacade()

svt::table::UnoGridColumnFacade::~UnoGridColumnFacade ( )
overridevirtual

Definition at line 176 of file unogridcolumnfacade.cxx.

◆ UnoGridColumnFacade() [2/2]

svt::table::UnoGridColumnFacade::UnoGridColumnFacade ( const UnoGridColumnFacade )
delete

Member Function Documentation

◆ columnChanged()

void svt::table::UnoGridColumnFacade::columnChanged ( ColumnAttributeGroup const  i_attributeGroup)

◆ dataColumnIndexChanged()

void svt::table::UnoGridColumnFacade::dataColumnIndexChanged ( )

◆ dispose()

void svt::table::UnoGridColumnFacade::dispose ( void  )

disposes the column wrapper

Note that the XGridColumn which is wrapped by the instance is not disposed, as we do not own it.

Definition at line 181 of file unogridcolumnfacade.cxx.

References DBG_TESTSOLARMUTEX, ENSURE_OR_RETURN_VOID, m_pChangeMultiplexer, m_pOwner, and m_xGridColumn.

Referenced by svt::table::UnoControlTableModel::removeAllColumns(), and svt::table::UnoControlTableModel::removeColumn().

◆ getDataColumnIndex()

sal_Int32 svt::table::UnoGridColumnFacade::getDataColumnIndex ( ) const
inline

◆ getFlexibility()

sal_Int32 svt::table::UnoGridColumnFacade::getFlexibility ( ) const
overridevirtual

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.

Implements svt::table::IColumnModel.

Definition at line 265 of file unogridcolumnfacade.cxx.

References ENSURE_OR_RETURN, and m_xGridColumn.

◆ getHelpText()

OUString svt::table::UnoGridColumnFacade::getHelpText ( ) const
overridevirtual

retrieves the help text to be displayed for the column.

Implements svt::table::IColumnModel.

Definition at line 242 of file unogridcolumnfacade.cxx.

References DBG_UNHANDLED_EXCEPTION, ENSURE_OR_RETURN, Exception, and m_xGridColumn.

◆ getHorizontalAlign()

css::style::HorizontalAlignment svt::table::UnoGridColumnFacade::getHorizontalAlign ( )
overridevirtual

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

Implements svt::table::IColumnModel.

Definition at line 300 of file unogridcolumnfacade.cxx.

References ENSURE_OR_RETURN, and m_xGridColumn.

◆ getMaxWidth()

TableMetrics svt::table::UnoGridColumnFacade::getMaxWidth ( ) const
overridevirtual

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

Implements svt::table::IColumnModel.

Definition at line 293 of file unogridcolumnfacade.cxx.

References ENSURE_OR_RETURN, and m_xGridColumn.

◆ getMinWidth()

TableMetrics svt::table::UnoGridColumnFacade::getMinWidth ( ) const
overridevirtual

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

Implements svt::table::IColumnModel.

Definition at line 286 of file unogridcolumnfacade.cxx.

References ENSURE_OR_RETURN, and m_xGridColumn.

◆ getName()

OUString svt::table::UnoGridColumnFacade::getName ( ) const
overridevirtual

returns the name of the column

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

See also
setName

Implements svt::table::IColumnModel.

Definition at line 226 of file unogridcolumnfacade.cxx.

References DBG_UNHANDLED_EXCEPTION, ENSURE_OR_RETURN, Exception, m_xGridColumn, and sName.

◆ getWidth()

TableMetrics svt::table::UnoGridColumnFacade::getWidth ( ) const
overridevirtual

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

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

See also
setWidth
getMinWidth
getMaxWidth

Implements svt::table::IColumnModel.

Definition at line 272 of file unogridcolumnfacade.cxx.

References ENSURE_OR_RETURN, and m_xGridColumn.

◆ impl_updateDataColumnIndex_nothrow()

void svt::table::UnoGridColumnFacade::impl_updateDataColumnIndex_nothrow ( )
private

◆ isResizable()

bool svt::table::UnoGridColumnFacade::isResizable ( ) const
overridevirtual

determines whether the column can be interactively resized

See also
getMinWidth
getMaxWidth
getWidth

Implements svt::table::IColumnModel.

Definition at line 258 of file unogridcolumnfacade.cxx.

References ENSURE_OR_RETURN, and m_xGridColumn.

◆ operator=()

UnoGridColumnFacade & svt::table::UnoGridColumnFacade::operator= ( const UnoGridColumnFacade )
delete

◆ setWidth()

void svt::table::UnoGridColumnFacade::setWidth ( TableMetrics  _nWidth)
overridevirtual

sets a new width for the column

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

Implements svt::table::IColumnModel.

Definition at line 279 of file unogridcolumnfacade.cxx.

References ENSURE_OR_RETURN_VOID, and m_xGridColumn.

Member Data Documentation

◆ m_nDataColumnIndex

sal_Int32 svt::table::UnoGridColumnFacade::m_nDataColumnIndex
private

◆ m_pChangeMultiplexer

::rtl::Reference< ColumnChangeMultiplexer > svt::table::UnoGridColumnFacade::m_pChangeMultiplexer
private

Definition at line 81 of file unogridcolumnfacade.hxx.

Referenced by dispose().

◆ m_pOwner

UnoControlTableModel const* svt::table::UnoGridColumnFacade::m_pOwner
private

Definition at line 78 of file unogridcolumnfacade.hxx.

Referenced by columnChanged(), dataColumnIndexChanged(), and dispose().

◆ m_xGridColumn

css::uno::Reference< css::awt::grid::XGridColumn > svt::table::UnoGridColumnFacade::m_xGridColumn
private

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