LibreOffice Module sw (master)  1
Public Member Functions | Private Member Functions | Private Attributes | List of all members
AddressPreview Class Reference

#include <mailmergehelper.hxx>

Inheritance diagram for AddressPreview:
Collaboration diagram for AddressPreview:

Public Member Functions

 AddressPreview (std::unique_ptr< weld::ScrolledWindow > xParent)
virtual ~AddressPreview () override
void AddAddress (const OUString &rAddress)
 The address string is a list of address elements separated by spaces and breaks. More...
void SetAddress (const OUString &rAddress)
sal_uInt16 GetSelectedAddress () const
void SelectAddress (sal_uInt16 nSelect)
void ReplaceSelectedAddress (const OUString &)
void RemoveSelectedAddress ()
void SetLayout (sal_uInt16 nRows, sal_uInt16 nColumns)
void EnableScrollBar ()
- Public Member Functions inherited from weld::CustomWidgetController
virtual css::uno::Reference< css::accessibility::XAccessible > CreateAccessible ()
virtual void Resize ()
virtual bool MouseMove (const MouseEvent &)
virtual bool MouseButtonUp (const MouseEvent &)
virtual void GetFocus ()
virtual void LoseFocus ()
virtual void StyleUpdated ()
virtual bool ContextMenu (const CommandEvent &)
virtual tools::Rectangle GetFocusRect ()
virtual FactoryFunction GetUITestFactory () const
virtual OUString RequestHelp (tools::Rectangle &)
virtual OUString GetHelpText () const
Size const & GetOutputSizePixel () const
void SetOutputSizePixel (const Size &rSize)
virtual void SetDrawingArea (weld::DrawingArea *pDrawingArea)
weld::DrawingAreaGetDrawingArea () const
void Invalidate ()
void Invalidate (const tools::Rectangle &rRect)
virtual void Show ()
virtual void Hide ()
void GrabFocus ()
bool HasFocus () const
bool IsVisible () const
bool IsReallyVisible () const
bool IsEnabled () const
int GetTextHeight () const
OUString GetAccessibleName () const
OUString GetAccessibleDescription () const
void CaptureMouse ()
bool IsMouseCaptured () const
void EnableRTL (bool bEnable)
bool IsRTLEnabled () const
void ReleaseMouse ()
void SetPointer (PointerStyle ePointerStyle)
void SetHelpId (const OString &rHelpId)
void SetAccessibleName (const OUString &rName)
void set_size_request (int nWidth, int nHeight)
void queue_resize ()
 CustomWidgetController ()
virtual ~CustomWidgetController ()
 CustomWidgetController (CustomWidgetController const &)=default
 CustomWidgetController (CustomWidgetController &&)=default
CustomWidgetControlleroperator= (CustomWidgetController const &)=default
CustomWidgetControlleroperator= (CustomWidgetController &&)=default

Private Member Functions

void DrawText_Impl (vcl::RenderContext &rRenderContext, const OUString &rAddress, const Point &rTopLeft, const Size &rSize, bool bIsSelected)
virtual void Paint (vcl::RenderContext &rRenderContext, const tools::Rectangle &) override
virtual bool MouseButtonDown (const MouseEvent &rMEvt) override
virtual bool KeyInput (const KeyEvent &rKEvt) override
void UpdateScrollBar ()
 DECL_LINK (ScrollHdl, weld::ScrolledWindow &, void)

Private Attributes

std::unique_ptr< SwAddressPreview_ImplpImpl
std::unique_ptr< weld::ScrolledWindowm_xVScrollBar

Additional Inherited Members

- Static Public Member Functions inherited from weld::CustomWidgetController
static bool IsUpdateMode ()

Detailed Description

Definition at line 112 of file mailmergehelper.hxx.

Constructor & Destructor Documentation

AddressPreview::AddressPreview ( std::unique_ptr< weld::ScrolledWindow xParent)

Definition at line 528 of file mailmergehelper.cxx.

References LINK, and m_xVScrollBar.

AddressPreview::~AddressPreview ( )

Definition at line 536 of file mailmergehelper.cxx.

Member Function Documentation

void AddressPreview::AddAddress ( const OUString &  rAddress)

The address string is a list of address elements separated by spaces and breaks.

The addresses fit into the given layout. If more addresses then rows/columns should be used a scrollbar will be added.

AddAddress appends the new address to the already added ones. Initially the first added address will be selected

Definition at line 545 of file mailmergehelper.cxx.

References pImpl, and UpdateScrollBar().

AddressPreview::DECL_LINK ( ScrollHdl  ,
weld::ScrolledWindow ,
void AddressPreview::DrawText_Impl ( vcl::RenderContext rRenderContext,
const OUString &  rAddress,
const Point rTopLeft,
const Size rSize,
bool  bIsSelected 
void AddressPreview::EnableScrollBar ( )

Definition at line 598 of file mailmergehelper.cxx.

References pImpl.

sal_uInt16 AddressPreview::GetSelectedAddress ( ) const

Definition at line 559 of file mailmergehelper.cxx.

References pImpl.

bool AddressPreview::KeyInput ( const KeyEvent rKEvt)
bool AddressPreview::MouseButtonDown ( const MouseEvent rMEvt)
void AddressPreview::Paint ( vcl::RenderContext rRenderContext,
const tools::Rectangle  
void AddressPreview::RemoveSelectedAddress ( )
void AddressPreview::ReplaceSelectedAddress ( const OUString &  rNew)

Definition at line 576 of file mailmergehelper.cxx.

References weld::CustomWidgetController::Invalidate(), and pImpl.

void AddressPreview::SelectAddress ( sal_uInt16  nSelect)

Definition at line 565 of file mailmergehelper.cxx.

References m_xVScrollBar, and pImpl.

void AddressPreview::SetAddress ( const OUString &  rAddress)
void AddressPreview::SetLayout ( sal_uInt16  nRows,
sal_uInt16  nColumns 

Definition at line 591 of file mailmergehelper.cxx.

References pImpl, and UpdateScrollBar().

void AddressPreview::UpdateScrollBar ( )

Definition at line 603 of file mailmergehelper.cxx.

References m_xVScrollBar, and pImpl.

Referenced by AddAddress(), RemoveSelectedAddress(), and SetLayout().

Member Data Documentation

std::unique_ptr<weld::ScrolledWindow> AddressPreview::m_xVScrollBar
std::unique_ptr<SwAddressPreview_Impl> AddressPreview::pImpl

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