266 lines
11 KiB
C++
266 lines
11 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#ifndef INCLUDED_VCL_LSTBOX_HXX
|
|
#define INCLUDED_VCL_LSTBOX_HXX
|
|
|
|
#include <vcl/dllapi.h>
|
|
#include <vcl/ctrl.hxx>
|
|
#include <vcl/lstbox.h>
|
|
|
|
class Image;
|
|
class ImplListBox;
|
|
class ImplListBoxFloatingWindow;
|
|
class ImplBtn;
|
|
class ImplWin;
|
|
|
|
|
|
// - ListBox -
|
|
|
|
|
|
class VCL_DLLPUBLIC ListBox : public Control
|
|
{
|
|
private:
|
|
VclPtr<ImplListBox> mpImplLB;
|
|
VclPtr<ImplListBoxFloatingWindow> mpFloatWin;
|
|
VclPtr<ImplWin> mpImplWin;
|
|
VclPtr<ImplBtn> mpBtn;
|
|
sal_uInt16 mnDDHeight;
|
|
sal_Int32 mnSaveValue;
|
|
sal_Int32 m_nMaxWidthChars;
|
|
Link<> maSelectHdl;
|
|
Link<> maDoubleClickHdl;
|
|
sal_uInt16 mnLineCount;
|
|
|
|
/// bitfield
|
|
bool mbDDAutoSize : 1;
|
|
bool mbEdgeBlending : 1;
|
|
|
|
private:
|
|
SAL_DLLPRIVATE void ImplInitListBoxData();
|
|
|
|
DECL_DLLPRIVATE_LINK( ImplSelectHdl, void* );
|
|
DECL_DLLPRIVATE_LINK( ImplScrollHdl, void* );
|
|
DECL_DLLPRIVATE_LINK( ImplCancelHdl, void* );
|
|
DECL_DLLPRIVATE_LINK( ImplDoubleClickHdl, void* );
|
|
DECL_DLLPRIVATE_LINK( ImplPopupModeEndHdl, void* );
|
|
DECL_DLLPRIVATE_LINK( ImplSelectionChangedHdl, void* );
|
|
DECL_DLLPRIVATE_LINK( ImplFocusHdl, void* );
|
|
DECL_DLLPRIVATE_LINK( ImplListItemSelectHdl, void* );
|
|
|
|
SAL_DLLPRIVATE void ImplClickButtonHandler( Control* );
|
|
SAL_DLLPRIVATE void ImplUserDrawHandler( UserDrawEvent* );
|
|
|
|
protected:
|
|
using Window::ImplInit;
|
|
SAL_DLLPRIVATE void ImplInit( vcl::Window* pParent, WinBits nStyle );
|
|
SAL_DLLPRIVATE WinBits ImplInitStyle( WinBits nStyle );
|
|
SAL_DLLPRIVATE void ImplLoadRes( const ResId& rResId );
|
|
bool IsDropDownBox() const { return mpFloatWin != nullptr; }
|
|
|
|
protected:
|
|
explicit ListBox( WindowType nType );
|
|
|
|
virtual void FillLayoutData() const SAL_OVERRIDE;
|
|
|
|
public:
|
|
explicit ListBox( vcl::Window* pParent, WinBits nStyle = WB_BORDER );
|
|
explicit ListBox( vcl::Window* pParent, const ResId& );
|
|
virtual ~ListBox();
|
|
virtual void dispose() SAL_OVERRIDE;
|
|
|
|
virtual void ApplySettings(vcl::RenderContext& rRenderContext) SAL_OVERRIDE;
|
|
virtual void Draw( OutputDevice* pDev, const Point& rPos, const Size& rSize, DrawFlags nFlags ) SAL_OVERRIDE;
|
|
virtual void Resize() SAL_OVERRIDE;
|
|
virtual bool PreNotify( NotifyEvent& rNEvt ) SAL_OVERRIDE;
|
|
virtual void StateChanged( StateChangedType nType ) SAL_OVERRIDE;
|
|
virtual void DataChanged( const DataChangedEvent& rDCEvt ) SAL_OVERRIDE;
|
|
virtual void UserDraw( const UserDrawEvent& rUDEvt );
|
|
|
|
virtual void Select();
|
|
virtual void DoubleClick();
|
|
virtual void GetFocus() SAL_OVERRIDE;
|
|
virtual void LoseFocus() SAL_OVERRIDE;
|
|
virtual vcl::Window* GetPreferredKeyInputWindow() SAL_OVERRIDE;
|
|
|
|
virtual const Wallpaper& GetDisplayBackground() const SAL_OVERRIDE;
|
|
|
|
virtual void setPosSizePixel( long nX, long nY,
|
|
long nWidth, long nHeight, PosSizeFlags nFlags = PosSizeFlags::All ) SAL_OVERRIDE;
|
|
void SetPosSizePixel( const Point& rNewPos, const Size& rNewSize ) SAL_OVERRIDE
|
|
{ Control::SetPosSizePixel( rNewPos, rNewSize ); }
|
|
|
|
Rectangle GetDropDownPosSizePixel() const;
|
|
|
|
void AdaptDropDownLineCountToMaximum();
|
|
void SetDropDownLineCount( sal_uInt16 nLines );
|
|
sal_uInt16 GetDropDownLineCount() const;
|
|
|
|
void EnableAutoSize( bool bAuto );
|
|
bool IsAutoSizeEnabled() const { return mbDDAutoSize; }
|
|
|
|
void EnableDDAutoWidth( bool b );
|
|
|
|
sal_Int32 InsertEntry( const OUString& rStr, sal_Int32 nPos = LISTBOX_APPEND );
|
|
sal_Int32 InsertEntry( const OUString& rStr, const Image& rImage, sal_Int32 nPos = LISTBOX_APPEND );
|
|
void RemoveEntry( const OUString& rStr );
|
|
void RemoveEntry( sal_Int32 nPos );
|
|
|
|
void Clear();
|
|
|
|
sal_Int32 GetEntryPos( const OUString& rStr ) const;
|
|
sal_Int32 GetEntryPos( const void* pData ) const;
|
|
Image GetEntryImage( sal_Int32 nPos ) const;
|
|
OUString GetEntry( sal_Int32 nPos ) const;
|
|
sal_Int32 GetEntryCount() const;
|
|
|
|
void SelectEntry( const OUString& rStr, bool bSelect = true );
|
|
void SelectEntryPos( sal_Int32 nPos, bool bSelect = true );
|
|
|
|
sal_Int32 GetSelectEntryCount() const;
|
|
OUString GetSelectEntry( sal_Int32 nSelIndex = 0 ) const;
|
|
sal_Int32 GetSelectEntryPos( sal_Int32 nSelIndex = 0 ) const;
|
|
|
|
bool IsEntrySelected(const OUString& rStr) const;
|
|
bool IsEntryPosSelected( sal_Int32 nPos ) const;
|
|
void SetNoSelection();
|
|
|
|
void SetEntryData( sal_Int32 nPos, void* pNewData );
|
|
void* GetEntryData( sal_Int32 nPos ) const;
|
|
void* GetSelectEntryData() const { return GetEntryData(GetSelectEntryPos()); }
|
|
|
|
/** this methods stores a combination of flags from the
|
|
ListBoxEntryFlags::* defines at the given entry.
|
|
See description of the possible ListBoxEntryFlags::* flags
|
|
for details.
|
|
Do not use these flags for user data as they are reserved
|
|
to change the internal behaviour of the ListBox implementation
|
|
for specific entries.
|
|
*/
|
|
void SetEntryFlags( sal_Int32 nPos, ListBoxEntryFlags nFlags );
|
|
|
|
/** this methods gets the current combination of flags from the
|
|
ListBoxEntryFlags::* defines from the given entry.
|
|
See description of the possible ListBoxEntryFlags::* flags
|
|
for details.
|
|
*/
|
|
ListBoxEntryFlags GetEntryFlags( sal_Int32 nPos ) const;
|
|
|
|
void SetTopEntry( sal_Int32 nPos );
|
|
sal_Int32 GetTopEntry() const;
|
|
|
|
void SaveValue() { mnSaveValue = GetSelectEntryPos(); }
|
|
sal_Int32 GetSavedValue() const { return mnSaveValue; }
|
|
bool IsValueChangedFromSaved() const { return mnSaveValue != GetSelectEntryPos(); }
|
|
|
|
void SetSeparatorPos( sal_Int32 n = LISTBOX_ENTRY_NOTFOUND );
|
|
sal_Int32 GetSeparatorPos() const;
|
|
|
|
bool IsTravelSelect() const;
|
|
bool IsInDropDown() const;
|
|
void ToggleDropDown();
|
|
|
|
void EnableMultiSelection( bool bMulti, bool bStackSelection );
|
|
void EnableMultiSelection( bool bMulti );
|
|
bool IsMultiSelectionEnabled() const;
|
|
|
|
void SetReadOnly( bool bReadOnly = true );
|
|
bool IsReadOnly() const;
|
|
|
|
Rectangle GetBoundingRectangle( sal_Int32 nItem ) const;
|
|
|
|
void SetUserItemSize( const Size& rSz );
|
|
|
|
void EnableUserDraw( bool bUserDraw );
|
|
|
|
void DrawEntry( const UserDrawEvent& rEvt, bool bDrawImage, bool bDrawText, bool bDrawTextAtImagePos = false );
|
|
|
|
void SetSelectHdl( const Link<>& rLink ) { maSelectHdl = rLink; }
|
|
const Link<>& GetSelectHdl() const { return maSelectHdl; }
|
|
void SetDoubleClickHdl( const Link<>& rLink ) { maDoubleClickHdl = rLink; }
|
|
const Link<>& GetDoubleClickHdl() const { return maDoubleClickHdl; }
|
|
|
|
Size CalcSubEditSize() const; //size of area inside lstbox, i.e. no scrollbar/dropdown
|
|
Size CalcMinimumSize() const; //size of lstbox area, i.e. including scrollbar/dropdown
|
|
virtual Size GetOptimalSize() const SAL_OVERRIDE;
|
|
Size CalcAdjustedSize( const Size& rPrefSize ) const;
|
|
Size CalcBlockSize( sal_uInt16 nColumns, sal_uInt16 nLines ) const;
|
|
void GetMaxVisColumnsAndLines( sal_uInt16& rnCols, sal_uInt16& rnLines ) const;
|
|
|
|
sal_uInt16 GetDisplayLineCount() const;
|
|
|
|
void EnableMirroring();
|
|
|
|
bool GetEdgeBlending() const { return mbEdgeBlending; }
|
|
void SetEdgeBlending(bool bNew);
|
|
|
|
/** checks whether a certain point lies within the bounds of
|
|
a listbox item and returns the item as well as the character position
|
|
the point is at.
|
|
|
|
<p>If the point is inside an item the item pos is put into <code>rPos</code> and
|
|
the item-relative character index is returned. If the point is not inside
|
|
an item -1 is returned and rPos is unchanged.</p>
|
|
|
|
@param rPoint
|
|
tells the point for which an item is requested.
|
|
|
|
@param rPos
|
|
gets the item at the specified point <code>rPoint</code>
|
|
|
|
@returns
|
|
the item-relative character index at point <code>rPos</code> or -1
|
|
if no item is at that point.
|
|
*/
|
|
using Control::GetIndexForPoint;
|
|
long GetIndexForPoint( const Point& rPoint, sal_Int32 & rPos ) const;
|
|
|
|
sal_Int32 getMaxWidthChars() const { return m_nMaxWidthChars; }
|
|
void setMaxWidthChars(sal_Int32 nWidth);
|
|
|
|
virtual bool set_property(const OString &rKey, const OString &rValue) SAL_OVERRIDE;
|
|
|
|
void EnableQuickSelection( const bool& b );
|
|
};
|
|
|
|
|
|
// - MultiListBox -
|
|
|
|
|
|
class VCL_DLLPUBLIC MultiListBox : public ListBox
|
|
{
|
|
public:
|
|
using ListBox::SaveValue;
|
|
using ListBox::GetSavedValue;
|
|
using ListBox::IsValueChangedFromSaved;
|
|
private:
|
|
// Bei MultiListBox nicht erlaubt...
|
|
void SaveValue();
|
|
sal_Int32 GetSavedValue();
|
|
bool IsValueChangedFromSaved() const;
|
|
|
|
public:
|
|
explicit MultiListBox( vcl::Window* pParent, WinBits nStyle = 0 );
|
|
|
|
};
|
|
|
|
#endif // INCLUDED_VCL_LSTBOX_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|