LibreOffice Module vcl (master) 1
tabctrl.hxx
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef INCLUDED_VCL_TABCTRL_HXX
21#define INCLUDED_VCL_TABCTRL_HXX
22
23#include <config_options.h>
24#include <vcl/dllapi.h>
25#include <vcl/ctrl.hxx>
26#include <vcl/EnumContext.hxx>
28
29class ImplTabItem;
30struct ImplTabCtrlData;
31class TabPage;
32class Button;
33class PushButton;
34class ListBox;
35class ToolBox;
36
37#ifndef TAB_APPEND
38#define TAB_APPEND (sal_uInt16(0xFFFF))
39#define TAB_PAGE_NOTFOUND (sal_uInt16(0xFFFF))
40#endif /* !TAB_APPEND */
41
42#define TAB_OFFSET 3
43#define TAB_TABOFFSET_X 3
44#define TAB_TABOFFSET_Y 3
45#define TAB_EXTRASPACE_X 6
46#define TAB_BORDER_LEFT 1
47#define TAB_BORDER_TOP 1
48#define TAB_BORDER_RIGHT 2
49#define TAB_BORDER_BOTTOM 2
50
52{
53protected:
54 std::unique_ptr<ImplTabCtrlData> mpTabCtrlData;
57 sal_uInt16 mnActPageId;
58 sal_uInt16 mnCurPageId;
66
68 SAL_DLLPRIVATE void ImplInitSettings( bool bBackground );
69 SAL_DLLPRIVATE ImplTabItem* ImplGetItem( sal_uInt16 nId ) const;
70 SAL_DLLPRIVATE ImplTabItem* ImplGetItem(const Point& rPt) const;
71 SAL_DLLPRIVATE Size ImplGetItemSize( ImplTabItem* pItem, tools::Long nMaxWidth );
72 SAL_DLLPRIVATE tools::Rectangle ImplGetTabRect( sal_uInt16 nPos, tools::Long nWidth = -1, tools::Long nHeight = -1 );
73 SAL_DLLPRIVATE tools::Rectangle ImplGetTabRect(const ImplTabItem*, tools::Long nWidth, tools::Long nHeight);
74 SAL_DLLPRIVATE void ImplChangeTabPage( sal_uInt16 nId, sal_uInt16 nOldId );
75 SAL_DLLPRIVATE bool ImplPosCurTabPage();
76 virtual void ImplActivateTabPage( bool bNext );
77 SAL_DLLPRIVATE void ImplShowFocus();
78 SAL_DLLPRIVATE void ImplDrawItem(vcl::RenderContext& rRenderContext, ImplTabItem const * pItem,
79 const tools::Rectangle& rCurRect, bool bFirstInGroup,
80 bool bLastInGroup);
81 SAL_DLLPRIVATE void ImplFreeLayoutData();
82 SAL_DLLPRIVATE bool ImplHandleKeyEvent( const KeyEvent& rKeyEvent );
83
84 DECL_DLLPRIVATE_LINK( ImplListBoxSelectHdl, ListBox&, void );
85 DECL_DLLPRIVATE_LINK( ImplWindowEventListener, VclWindowEvent&, void );
86
87 using Window::ImplInit;
88 SAL_DLLPRIVATE void ImplInit( vcl::Window* pParent, WinBits nStyle );
89
90 virtual void FillLayoutData() const override;
91 virtual const vcl::Font& GetCanonicalFont( const StyleSettings& _rStyle ) const override;
92 virtual const Color& GetCanonicalTextColor( const StyleSettings& _rStyle ) const override;
93 virtual bool ImplPlaceTabs( tools::Long nWidth );
94 SAL_DLLPRIVATE Size ImplCalculateRequisition(sal_uInt16& nHeaderHeight) const;
95
96public:
97 TabControl( vcl::Window* pParent,
98 WinBits nStyle = WB_STDTABCONTROL );
99 virtual ~TabControl() override;
100 virtual void dispose() override;
101
102 virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
103 virtual void KeyInput( const KeyEvent& rKEvt ) override;
104 virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
105 virtual void Resize() override;
106 virtual void GetFocus() override;
107 virtual void LoseFocus() override;
108 virtual void RequestHelp( const HelpEvent& rHEvt ) override;
109 virtual void Command( const CommandEvent& rCEvt ) override;
110 virtual bool EventNotify( NotifyEvent& rNEvt ) override;
111 virtual void StateChanged( StateChangedType nType ) override;
112 virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
113 virtual bool PreNotify( NotifyEvent& rNEvt ) override;
114
115 void ActivatePage();
116 bool DeactivatePage();
117
118 virtual Size GetOptimalSize() const override;
119
120 void SetTabPageSizePixel( const Size& rSize );
121
122 void InsertPage( sal_uInt16 nPageId, const OUString& rText,
123 sal_uInt16 nPos = TAB_APPEND );
124 void RemovePage( sal_uInt16 nPageId );
125
126 void SetPageEnabled(sal_uInt16 nPageId, bool bEnable = true);
127 void SetPageVisible(sal_uInt16 nPageId, bool bVisible = true);
128
129 sal_uInt16 GetPagePos( sal_uInt16 nPageId ) const;
130 sal_uInt16 GetPageCount() const;
131 sal_uInt16 GetPageId( sal_uInt16 nPos ) const;
132 sal_uInt16 GetPageId(const Point& rPos) const;
133 sal_uInt16 GetPageId( const OString& rName ) const;
134
135 void SetCurPageId(sal_uInt16 nPageId);
136 sal_uInt16 GetCurPageId() const;
137
138 void SelectTabPage( sal_uInt16 nPageId );
139
140 void SetTabPage(sal_uInt16 nPageId, TabPage* pPage);
141 TabPage* GetTabPage( sal_uInt16 nPageId ) const;
142
143 void SetPageText( sal_uInt16 nPageId, const OUString& rText );
144 OUString const & GetPageText( sal_uInt16 nPageId ) const;
145
146 void SetHelpText( sal_uInt16 nPageId, const OUString& rText );
147 const OUString& GetHelpText( sal_uInt16 nPageId ) const;
148
149 void SetPageName( sal_uInt16 nPageId, const OString& rName ) const;
150 OString GetPageName( sal_uInt16 nPageId ) const;
151
152 void SetAccessibleName( sal_uInt16 nItemId, const OUString& rStr );
153 OUString GetAccessibleName( sal_uInt16 nItemId ) const;
154
155 void SetAccessibleDescription( sal_uInt16 nItemId, const OUString& rStr );
156 OUString GetAccessibleDescription( sal_uInt16 nItemId ) const;
157
158 void SetPageImage( sal_uInt16 nPageId, const Image& rImage );
159
160 using Control::SetHelpId;
161 using Control::GetHelpId;
162
163 void SetActivatePageHdl( const Link<TabControl*,void>& rLink ) { maActivateHdl = rLink; }
164 void SetDeactivatePageHdl( const Link<TabControl*, bool>& rLink ) { maDeactivateHdl = rLink; }
165
166 // returns (control relative) bounding rectangle for the
167 // character at index nIndex relative to the text of page nPageId
169 tools::Rectangle GetCharacterBounds( sal_uInt16 nPageId, tools::Long nIndex ) const;
170
171 // returns the index relative to the text of page nPageId (also returned)
172 // at position rPoint (control relative)
174 tools::Long GetIndexForPoint( const Point& rPoint, sal_uInt16& rPageId ) const;
175
176 // returns the rectangle of the tab for page nPageId
177 tools::Rectangle GetTabBounds( sal_uInt16 nPageId ) const;
178
179 virtual void SetPosPixel(const Point& rPos) override;
180 virtual void SetSizePixel(const Size& rNewSize) override;
181 virtual void SetPosSizePixel(const Point& rNewPos, const Size& rNewSize) override;
182
183 virtual Size calculateRequisition() const;
184 void setAllocation(const Size &rAllocation);
185
186 std::vector<sal_uInt16> GetPageIDs() const;
187
188 virtual FactoryFunction GetUITestFactory() const override;
189
190 virtual void queue_resize(StateChangedType eReason = StateChangedType::Layout) override;
191
192 virtual bool set_property(const OString &rKey, const OUString &rValue) override;
193
194 virtual void DumpAsPropertyTree(tools::JsonWriter&) override;
195};
196
197class NotebookBar;
198
199class UNLESS_MERGELIBS(VCL_DLLPUBLIC) NotebookbarTabControlBase : public TabControl,
201{
202public:
203 NotebookbarTabControlBase( vcl::Window* pParent );
204 ~NotebookbarTabControlBase() override;
205 void dispose() override;
206
207 void SetContext( vcl::EnumContext::Context eContext ) override;
208 void SetIconClickHdl( Link<NotebookBar*, void> aHdl );
209 void SetToolBox( ToolBox* pToolBox );
210 ToolBox* GetToolBox() { return m_pShortcuts; }
211 Control* GetOpenMenu();
212
213 virtual Size calculateRequisition() const override;
214 static sal_uInt16 GetHeaderHeight();
215
216protected:
217 virtual bool ImplPlaceTabs( tools::Long nWidth ) override;
218 virtual void ImplActivateTabPage( bool bNext ) override;
219
220private:
221 bool bLastContextWasSupported;
222 vcl::EnumContext::Context eLastContext;
223 Link<NotebookBar*,void> m_aIconClickHdl;
224 static sal_uInt16 m_nHeaderHeight;
225 VclPtr<ToolBox> m_pShortcuts;
226 VclPtr<PushButton> m_pOpenMenu;
227 DECL_DLLPRIVATE_LINK(OpenMenu, Button*, void);
228};
229
230#endif // INCLUDED_VCL_TABCTRL_HXX
231
232/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Definition: ctrl.hxx:82
tools::Long GetIndexForPoint(const Point &rPoint) const
Definition: ctrl.cxx:135
virtual void FillLayoutData() const
Definition: ctrl.cxx:81
virtual const Color & GetCanonicalTextColor(const StyleSettings &_rStyle) const
Definition: ctrl.cxx:409
virtual bool EventNotify(NotifyEvent &rNEvt) override
Definition: ctrl.cxx:226
virtual void StateChanged(StateChangedType nStateChange) override
Definition: ctrl.cxx:257
virtual void Resize() override
Definition: ctrl.cxx:75
virtual Size GetOptimalSize() const override
Definition: ctrl.cxx:370
void ImplInitSettings()
Definition: ctrl.cxx:424
tools::Rectangle GetCharacterBounds(tools::Long nIndex) const
Definition: ctrl.cxx:111
virtual const vcl::Font & GetCanonicalFont(const StyleSettings &_rStyle) const
Definition: ctrl.cxx:404
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects.
Definition: ctrl.cxx:59
Definition: image.hxx:40
A widget used to choose from a list of items and which has no entry.
Definition: lstbox.hxx:83
This implements Widget Layout-based notebook-like menu bar.
Definition: notebookbar.hxx:28
virtual void SetContext(vcl::EnumContext::Context eContext)=0
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:171
bool mbShowTabs
Definition: tabctrl.hxx:60
void SetDeactivatePageHdl(const Link< TabControl *, bool > &rLink)
Definition: tabctrl.hxx:164
bool mbRestoreHelpId
Definition: tabctrl.hxx:61
virtual Size calculateRequisition() const
Definition: tabctrl.cxx:2178
Link< TabControl *, bool > maDeactivateHdl
Definition: tabctrl.hxx:65
DECL_DLLPRIVATE_LINK(ImplWindowEventListener, VclWindowEvent &, void)
sal_uInt16 mnCurPageId
Definition: tabctrl.hxx:58
std::unique_ptr< ImplTabCtrlData > mpTabCtrlData
Definition: tabctrl.hxx:54
DECL_DLLPRIVATE_LINK(ImplListBoxSelectHdl, ListBox &, void)
virtual void dispose() override
This is intended to be used to clear any locally held references to other Window-subclass objects.
Definition: tabctrl.cxx:201
tools::Long mnLastWidth
Definition: tabctrl.hxx:55
virtual void ImplActivateTabPage(bool bNext)
Definition: tabctrl.cxx:737
bool mbSmallInvalidate
Definition: tabctrl.hxx:62
sal_uInt16 mnActPageId
Definition: tabctrl.hxx:57
bool mbLayoutDirty
Definition: tabctrl.hxx:63
virtual bool ImplPlaceTabs(tools::Long nWidth)
Definition: tabctrl.cxx:394
bool mbFormat
Definition: tabctrl.hxx:59
Link< TabControl *, void > maActivateHdl
Definition: tabctrl.hxx:64
void SetActivatePageHdl(const Link< TabControl *, void > &rLink)
Definition: tabctrl.hxx:163
tools::Long mnLastHeight
Definition: tabctrl.hxx:56
A toolbar: contains all those icons, typically below the menu bar.
Definition: toolbox.hxx:74
virtual void GetFocus()
Definition: window.cxx:1845
virtual void RequestHelp(const HelpEvent &rHEvt)
Definition: window.cxx:1873
void SetHelpText(const OUString &rHelpText)
Definition: window2.cxx:1251
virtual void SetSizePixel(const Size &rNewSize)
Definition: window2.cxx:1293
virtual void Command(const CommandEvent &rCEvt)
Definition: window.cxx:1927
virtual void queue_resize(StateChangedType eReason=StateChangedType::Layout)
Definition: window2.cxx:1358
virtual void MouseButtonDown(const MouseEvent &rMEvt)
Definition: mouse.cxx:420
void SetAccessibleDescription(const OUString &rDescr)
virtual void KeyInput(const KeyEvent &rKEvt)
Definition: window.cxx:1809
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)
Definition: paint.cxx:1020
const OString & GetHelpId() const
Definition: window2.cxx:854
virtual bool PreNotify(NotifyEvent &rNEvt)
Definition: event.cxx:52
void SetAccessibleName(const OUString &rName)
void SetHelpId(const OString &)
Definition: window2.cxx:849
virtual void DumpAsPropertyTree(tools::JsonWriter &)
Dumps itself and potentially its children to a property tree, to be written easily to JSON.
Definition: window.cxx:3365
virtual void DataChanged(const DataChangedEvent &rDCEvt)
Definition: event.cxx:36
virtual bool set_property(const OString &rKey, const OUString &rValue)
Definition: window2.cxx:1483
virtual void LoseFocus()
Definition: window.cxx:1859
OUString GetAccessibleName() const
virtual void SetPosPixel(const Point &rNewPos)
Definition: window2.cxx:1288
virtual void SetPosSizePixel(const Point &rNewPos, const Size &rNewSize)
Definition: window2.cxx:1299
OUString GetAccessibleDescription() const
SAL_DLLPRIVATE void ImplInit(vcl::Window *pParent, WinBits nStyle, SystemParentData *pSystemParentData)
Definition: window.cxx:942
const OUString & GetHelpText() const
Definition: window.cxx:3097
virtual FactoryFunction GetUITestFactory() const
Definition: window.cxx:3942
virtual void SetCurPageId(const OString &rName) override
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
std::function< std::unique_ptr< UIObject >(vcl::Window *)> FactoryFunction
long Long
#define TAB_APPEND
Definition: tabctrl.hxx:38
StateChangedType
Definition: window.hxx:291
sal_Int64 WinBits
Definition: wintypes.hxx:109
WinBits const WB_STDTABCONTROL
Definition: wintypes.hxx:219