LibreOffice Module vcl (master)  1
edit.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 #pragma once
21 
22 #if !defined(VCL_DLLIMPLEMENTATION) && !defined(TOOLKIT_DLLIMPLEMENTATION) && !defined(VCL_INTERNALS)
23 #error "don't use this in new code"
24 #endif
25 
26 #include <vcl/ctrl.hxx>
27 #include <vcl/textfilter.hxx>
28 
29 #include <memory>
30 
31 #include <rtl/ustrbuf.hxx>
32 #include <o3tl/deleter.hxx>
33 #include <vcl/dllapi.h>
34 #include <vcl/menu.hxx>
35 #include <vcl/dndhelp.hxx>
36 #include <vcl/vclptr.hxx>
37 #include <com/sun/star/uno/Reference.h>
38 
39 namespace com::sun::star::i18n {
40  class XBreakIterator;
41  class XExtendedInputSequenceChecker;
42 }
43 namespace weld {
44  class Widget;
45 }
46 
47 class VclBuilder;
48 struct DDInfo;
49 struct Impl_IMEInfos;
50 
51 #define EDIT_NOLIMIT SAL_MAX_INT32
52 
53 class Timer;
54 
56 {
57 private:
60  std::unique_ptr<DDInfo, o3tl::default_delete<DDInfo>> mpDDInfo;
61  std::unique_ptr<Impl_IMEInfos> mpIMEInfos;
62  OUStringBuffer maText;
64  OUString maSaveValue;
65  OUString maUndoText;
66  long mnXOffset;
68  sal_uInt16 mnAlign;
69  sal_Int32 mnMaxTextLen;
70  sal_Int32 mnWidthInChars;
71  sal_Int32 mnMaxWidthChars;
73  bool mbInternModified:1,
74  mbReadOnly:1,
75  mbInsertMode:1,
76  mbClickedInSelection:1,
77  mbIsSubEdit:1,
78  mbActivePopup:1,
79  mbForceControlBackground:1,
80  mbPassword;
84  std::unique_ptr<VclBuilder> mpUIBuilder;
85 
86  css::uno::Reference<css::i18n::XBreakIterator> mxBreakIterator;
87  css::uno::Reference<css::i18n::XExtendedInputSequenceChecker> mxISC;
88 
89  SAL_DLLPRIVATE bool ImplTruncateToMaxLen( OUString&, sal_Int32 nSelectionLen ) const;
90  SAL_DLLPRIVATE void ImplInitEditData();
91  SAL_DLLPRIVATE OUString ImplGetText() const;
92  SAL_DLLPRIVATE void ImplRepaint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRectangle);
93  SAL_DLLPRIVATE void ImplInvalidateOrRepaint();
94  SAL_DLLPRIVATE void ImplDelete( const Selection& rSelection, sal_uInt8 nDirection, sal_uInt8 nMode );
95  SAL_DLLPRIVATE void ImplSetText( const OUString& rStr, const Selection* pNewSelection );
96  SAL_DLLPRIVATE void ImplInsertText( const OUString& rStr, const Selection* pNewSelection = nullptr, bool bIsUserInput = false );
97  SAL_DLLPRIVATE static OUString ImplGetValidString( const OUString& rString );
98  SAL_DLLPRIVATE void ImplClearBackground(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRectangle, long nXStart, long nXEnd);
99  SAL_DLLPRIVATE void ImplPaintBorder(vcl::RenderContext const & rRenderContext);
100  SAL_DLLPRIVATE void ImplShowCursor( bool bOnlyIfVisible = true );
101  SAL_DLLPRIVATE void ImplAlign();
102  SAL_DLLPRIVATE void ImplAlignAndPaint();
103  SAL_DLLPRIVATE sal_Int32 ImplGetCharPos( const Point& rWindowPos ) const;
104  SAL_DLLPRIVATE void ImplSetCursorPos( sal_Int32 nChar, bool bSelect );
105  SAL_DLLPRIVATE void ImplShowDDCursor();
106  SAL_DLLPRIVATE void ImplHideDDCursor();
107  SAL_DLLPRIVATE bool ImplHandleKeyEvent( const KeyEvent& rKEvt );
108  SAL_DLLPRIVATE void ImplCopyToSelectionClipboard();
109  SAL_DLLPRIVATE void ImplCopy(css::uno::Reference<css::datatransfer::clipboard::XClipboard> const & rxClipboard);
110  SAL_DLLPRIVATE void ImplPaste(css::uno::Reference<css::datatransfer::clipboard::XClipboard> const & rxClipboard);
111  SAL_DLLPRIVATE long ImplGetTextYPosition() const;
112  SAL_DLLPRIVATE css::uno::Reference<css::i18n::XExtendedInputSequenceChecker> const& ImplGetInputSequenceChecker();
113  SAL_DLLPRIVATE css::uno::Reference<css::i18n::XBreakIterator> const& ImplGetBreakIterator();
114  SAL_DLLPRIVATE void filterText();
115 
116 protected:
118  using Window::ImplInit;
119  SAL_DLLPRIVATE void ImplInit( vcl::Window* pParent, WinBits nStyle );
120  SAL_DLLPRIVATE static WinBits ImplInitStyle( WinBits nStyle );
121  SAL_DLLPRIVATE void ImplSetSelection( const Selection& rSelection, bool bPaint = true );
122  SAL_DLLPRIVATE ControlType ImplGetNativeControlType() const;
123  SAL_DLLPRIVATE long ImplGetExtraXOffset() const;
124  SAL_DLLPRIVATE long ImplGetExtraYOffset() const;
125  static SAL_DLLPRIVATE void ImplInvalidateOutermostBorder( vcl::Window* pWin );
126 
127  css::uno::Reference<css::datatransfer::dnd::XDragSourceListener > mxDnDListener;
128 
129  // DragAndDropClient
133  virtual void dragGestureRecognized(const css::datatransfer::dnd::DragGestureEvent& dge) override;
134  virtual void dragDropEnd(const css::datatransfer::dnd::DragSourceDropEvent& dsde) override;
135  virtual void drop(const css::datatransfer::dnd::DropTargetDropEvent& dtde) override;
136  virtual void dragEnter(const css::datatransfer::dnd::DropTargetDragEnterEvent& dtdee) override;
137  virtual void dragExit(const css::datatransfer::dnd::DropTargetEvent& dte) override;
138  virtual void dragOver(const css::datatransfer::dnd::DropTargetDragEvent& dtde) override;
139 
140 protected:
141  Edit(WindowType nType);
142  virtual void FillLayoutData() const override;
143  virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
144 public:
145  // public because needed in button.cxx
146  SAL_DLLPRIVATE bool ImplUseNativeBorder(vcl::RenderContext const & rRenderContext, WinBits nStyle);
147 
148  Edit( vcl::Window* pParent, WinBits nStyle = WB_BORDER );
149  virtual ~Edit() override;
150  virtual void dispose() override;
151 
152  virtual void MouseButtonDown( const MouseEvent& rMEvt ) override;
153  virtual void MouseButtonUp( const MouseEvent& rMEvt ) override;
154  virtual void KeyInput( const KeyEvent& rKEvt ) override;
155  virtual void Paint( vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect ) override;
156  virtual void Resize() override;
157  virtual void Draw( OutputDevice* pDev, const Point& rPos, DrawFlags nFlags ) override;
158  virtual void GetFocus() override;
159  virtual void LoseFocus() override;
160  virtual void Tracking( const TrackingEvent& rTEvt ) override;
161  virtual void Command( const CommandEvent& rCEvt ) override;
162  virtual void StateChanged( StateChangedType nType ) override;
163  virtual void DataChanged( const DataChangedEvent& rDCEvt ) override;
164 
165  virtual void Modify();
166 
167  static bool IsCharInput( const KeyEvent& rKEvt );
168 
169  virtual void SetModifyFlag();
170 
171  void SetEchoChar( sal_Unicode c );
172  sal_Unicode GetEchoChar() const { return mcEchoChar; }
173 
174  virtual void SetReadOnly( bool bReadOnly = true );
175  virtual bool IsReadOnly() const { return mbReadOnly; }
176 
177  void SetInsertMode( bool bInsert );
178  bool IsInsertMode() const;
179 
180  virtual void SetMaxTextLen( sal_Int32 nMaxLen );
181  virtual sal_Int32 GetMaxTextLen() const { return mnMaxTextLen; }
182 
183  void SetWidthInChars(sal_Int32 nWidthInChars);
184  sal_Int32 GetWidthInChars() const { return mnWidthInChars; }
185 
186  void setMaxWidthChars(sal_Int32 nWidth);
187 
188  virtual void SetSelection( const Selection& rSelection );
189  virtual const Selection& GetSelection() const;
190 
191  virtual void ReplaceSelected( const OUString& rStr );
192  virtual void DeleteSelected();
193  virtual OUString GetSelected() const;
194 
195  virtual void Cut();
196  virtual void Copy();
197  virtual void Paste();
198  void Undo();
199 
200  virtual void SetText( const OUString& rStr ) override;
201  virtual void SetText( const OUString& rStr, const Selection& rNewSelection );
202  virtual OUString GetText() const override;
203 
204  void SetCursorAtLast();
205 
206  void SetPlaceholderText( const OUString& rStr );
207 
208  void SaveValue() { maSaveValue = GetText(); }
209  const OUString& GetSavedValue() const { return maSaveValue; }
210 
211  virtual void SetModifyHdl( const Link<Edit&,void>& rLink ) { maModifyHdl = rLink; }
212  virtual const Link<Edit&,void>& GetModifyHdl() const { return maModifyHdl; }
213 
214  void SetActivateHdl(const Link<Edit&,bool>& rLink) { maActivateHdl = rLink; }
215 
216  void SetSubEdit( Edit* pEdit );
217  Edit* GetSubEdit() const { return mpSubEdit; }
218 
219  void SetAutocompleteHdl( const Link<Edit&,void>& rLink ) { maAutocompleteHdl = rLink; }
220  const Link<Edit&,void>& GetAutocompleteHdl() const { return maAutocompleteHdl; }
221 
222  virtual Size CalcMinimumSize() const;
223  virtual Size CalcMinimumSizeForText(const OUString &rString) const;
224  virtual Size GetOptimalSize() const override;
225  virtual Size CalcSize(sal_Int32 nChars) const;
226  sal_Int32 GetMaxVisChars() const;
227 
228  // shows a warning box saying "text too long, truncated"
229  static void ShowTruncationWarning(weld::Widget* pParent);
230 
231  VclPtr<PopupMenu> CreatePopupMenu();
232 
233  virtual OUString GetSurroundingText() const override;
234  virtual Selection GetSurroundingTextSelection() const override;
235  virtual bool set_property(const OString &rKey, const OUString &rValue) override;
236 
237  void SetTextFilter(TextFilter* pFilter) { mpFilterText = pFilter; }
238 
239  virtual FactoryFunction GetUITestFactory() const override;
240 
241  void SetForceControlBackground(bool b) { mbForceControlBackground = b; }
242 
243  bool IsPassword() const { return mbPassword; }
244 };
245 
246 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
void SetActivateHdl(const Link< Edit &, bool > &rLink)
Definition: edit.hxx:214
sal_Int32 mnMaxWidthChars
Definition: edit.hxx:71
OUString maSaveValue
Definition: edit.hxx:64
virtual FactoryFunction GetUITestFactory() const
Definition: window.cxx:3864
sal_Int32 GetWidthInChars() const
Definition: edit.hxx:184
void GetSelection(struct ESelection &rSel, SvxTextForwarder const *pForwarder)
Link< Edit &, void > maModifyHdl
Definition: edit.hxx:81
virtual void MouseButtonDown(const MouseEvent &rMEvt)
Definition: mouse.cxx:414
sal_Unicode GetEchoChar() const
Definition: edit.hxx:172
Edit * GetSubEdit() const
Definition: edit.hxx:217
long mnXOffset
Definition: edit.hxx:66
virtual void dragExit(const css::datatransfer::dnd::DropTargetEvent &dte)
Definition: dndhelp.cxx:44
#define VCL_DLLPUBLIC
Definition: dllapi.h:29
void SaveValue()
Definition: edit.hxx:208
virtual void StateChanged(StateChangedType nStateChange) override
Definition: ctrl.cxx:260
OUString maPlaceholderText
Definition: edit.hxx:63
virtual void FillLayoutData() const
Definition: ctrl.cxx:80
std::function< std::unique_ptr< UIObject >vcl::Window *)> FactoryFunction
void SetForceControlBackground(bool b)
Definition: edit.hxx:241
sal_uInt16 mnAlign
Definition: edit.hxx:68
css::uno::Reference< css::datatransfer::dnd::XDragSourceListener > mxDnDListener
Definition: edit.hxx:127
virtual const Link< Edit &, void > & GetModifyHdl() const
Definition: edit.hxx:212
virtual void ApplySettings(vcl::RenderContext &rRenderContext) override
Definition: ctrl.cxx:418
virtual void MouseButtonUp(const MouseEvent &rMEvt)
Definition: mouse.cxx:421
StateChangedType
Definition: window.hxx:317
virtual void dragOver(const css::datatransfer::dnd::DropTargetDragEvent &dtde)
Definition: dndhelp.cxx:48
sal_Int64 WinBits
sal_uInt16 sal_Unicode
virtual void SetModifyHdl(const Link< Edit &, void > &rLink)
Definition: edit.hxx:211
Creates a hierarchy of vcl::Windows (widgets) from a .ui file for dialogs, sidebar, etc.
Definition: builder.hxx:64
virtual void Tracking(const TrackingEvent &rTEvt)
Definition: window.cxx:1926
virtual sal_Int32 GetMaxTextLen() const
Definition: edit.hxx:181
css::uno::Reference< css::i18n::XBreakIterator > mxBreakIterator
Definition: edit.hxx:86
const Link< Edit &, void > & GetAutocompleteHdl() const
Definition: edit.hxx:220
virtual OUString GetText() const
Definition: window.cxx:3039
sal_Int32 mnMaxTextLen
Definition: edit.hxx:69
Definition: edit.cxx:90
Definition: edit.hxx:55
OUString maUndoText
Definition: edit.hxx:65
virtual Selection GetSurroundingTextSelection() const
Definition: window.cxx:3770
std::unique_ptr< Impl_IMEInfos > mpIMEInfos
Definition: edit.hxx:61
OUStringBuffer maText
Definition: edit.hxx:62
Selection maSelection
Definition: edit.hxx:67
virtual OUString GetSurroundingText() const
Definition: window.cxx:3765
DrawFlags
Definition: window.hxx:360
virtual void dragDropEnd(const css::datatransfer::dnd::DragSourceDropEvent &dsde)
Definition: dndhelp.cxx:32
virtual void SetText(const OUString &rStr) override
Definition: ctrl.cxx:95
std::unique_ptr< VclBuilder > mpUIBuilder
Definition: edit.hxx:84
Some things multiple-inherit from VclAbstractDialog and OutputDevice, so we need to use virtual inher...
Definition: outdev.hxx:302
virtual void Draw(::OutputDevice *pDev, const Point &rPos, DrawFlags nFlags)
Definition: window.cxx:1823
sal_Unicode mcEchoChar
Definition: edit.hxx:72
void SetTextFilter(TextFilter *pFilter)
Definition: edit.hxx:237
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
virtual bool set_property(const OString &rKey, const OUString &rValue)
Definition: window2.cxx:1431
virtual void LoseFocus()
Definition: window.cxx:1849
ControlType
These types are all based on the supported variants vcl/salnativewidgets.hxx and must be kept in-sync...
virtual void KeyInput(const KeyEvent &rKEvt)
Definition: window.cxx:1799
SAL_DLLPRIVATE void ImplInit(vcl::Window *pParent, WinBits nStyle, SystemParentData *pSystemParentData)
Definition: window.cxx:935
virtual Size GetOptimalSize() const override
Definition: ctrl.cxx:374
std::unique_ptr< DDInfo, o3tl::default_delete< DDInfo > > mpDDInfo
Definition: edit.hxx:60
css::uno::Reference< css::i18n::XExtendedInputSequenceChecker > mxISC
Definition: edit.hxx:87
Link< Edit &, void > maAutocompleteHdl
Definition: edit.hxx:82
virtual void Resize() override
Definition: ctrl.cxx:74
WindowType
Definition: ctrl.hxx:33
virtual void GetFocus()
Definition: window.cxx:1835
unsigned char sal_uInt8
Link< Edit &, bool > maActivateHdl
Definition: edit.hxx:83
const OUString & GetSavedValue() const
Definition: edit.hxx:209
virtual void Paint(vcl::RenderContext &rRenderContext, const tools::Rectangle &rRect)
Definition: paint.cxx:1019
virtual void dragGestureRecognized(const css::datatransfer::dnd::DragGestureEvent &dge)
Definition: dndhelp.cxx:28
VclPtr< Edit > mpSubEdit
Definition: edit.hxx:58
void SetAutocompleteHdl(const Link< Edit &, void > &rLink)
Definition: edit.hxx:219
void ImplInitSettings()
Definition: ctrl.cxx:428
virtual void dragEnter(const css::datatransfer::dnd::DropTargetDragEnterEvent &dtdee)
Definition: dndhelp.cxx:40
Definition: timer.hxx:26
virtual bool IsReadOnly() const
Definition: edit.hxx:175
virtual void drop(const css::datatransfer::dnd::DropTargetDropEvent &dtde)
Definition: dndhelp.cxx:36
virtual void Command(const CommandEvent &rCEvt)
Definition: window.cxx:1917
sal_Int32 mnWidthInChars
Definition: edit.hxx:70
TextFilter * mpFilterText
Definition: edit.hxx:59
virtual void DataChanged(const DataChangedEvent &rDCEvt)
Definition: event.cxx:35
bool IsPassword() const
Definition: edit.hxx:243