include/formula/funcutl.hxx

   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_FORMULA_FUNCUTL_HXX
  21 #define INCLUDED_FORMULA_FUNCUTL_HXX
  22
  23 #include <formula/formuladllapi.h>
  24 #include <rtl/ustring.hxx>
  25 #include <tools/link.hxx>
  26 #include <vcl/idle.hxx>
  27 #include <vcl/weld.hxx>
  28
  29 class KeyEvent;
  30 struct ImplSVEvent;
  31
  32 namespace formula {
  33
  34 class IControlReferenceHandler;
  35
  36 class FORMULA_DLLPUBLIC RefEdit
  37 {
  38 protected:
  39     std::unique_ptr<weld::Entry> xEntry;
  40
  41 private:
  42     Idle aIdle;
  43     IControlReferenceHandler* pAnyRefDlg; // parent dialog
  44     weld::Label* pLabelWidget;
  45     ImplSVEvent* mpFocusInEvent;
  46     ImplSVEvent* mpFocusOutEvent;
  47
  48     Link<RefEdit&,void> maGetFocusHdl;
  49     Link<RefEdit&,void> maLoseFocusHdl;
  50     Link<RefEdit&,void> maModifyHdl;
  51     Link<weld::Widget&,bool> maActivateHdl;
  52
  53     DECL_DLLPRIVATE_LINK( UpdateHdl, Timer*, void );
  54
  55     DECL_DLLPRIVATE_LINK(KeyInputHdl, const KeyEvent&, bool);
  56     DECL_DLLPRIVATE_LINK(GetFocusHdl, weld::Widget&, void);
  57     DECL_DLLPRIVATE_LINK(LoseFocusHdl, weld::Widget&, void);
  58     DECL_DLLPRIVATE_LINK(AsyncFocusInHdl, void*, void);
  59     DECL_DLLPRIVATE_LINK(AsyncFocusOutHdl, void*, void);
  60     DECL_DLLPRIVATE_LINK(Modify, weld::Entry&, void);
  61
  62     void GetFocus();
  63     void LoseFocus();
  64
  65 protected:
  66     virtual bool KeyInput(const KeyEvent& rKEvt);
  67
  68 public:
  69     RefEdit(std::unique_ptr<weld::Entry> xControl);
  70     weld::Entry* GetWidget() const { return xEntry.get(); }
  71     virtual ~RefEdit();
  72
  73     void SetRefString( const OUString& rStr );
  74
  75     /**
  76      * Flag reference valid or invalid, which in turn changes the visual
  77      * appearance of the control accordingly.
  78      */
  79     void SetRefValid(bool bValid);
  80
  81     void SetText(const OUString& rStr);
  82     OUString GetText() const
  83     {
  84         return xEntry->get_text();
  85     }
  86
  87     void StartUpdateData();
  88
  89     void SetReferences( IControlReferenceHandler* pDlg, weld::Label *pLabelWidget );
  90
  91     void DoModify()
  92     {
  93         Modify(*xEntry);
  94     }
  95
  96     void GrabFocus()
  97     {
  98         xEntry->grab_focus();
  99     }
 100
 101     void SelectAll()
 102     {
 103         xEntry->select_region(0, -1);
 104     }
 105
 106     void SetSelection(const Selection& rSelection)
 107     {
 108         xEntry->select_region(rSelection.Min(), rSelection.Max());
 109     }
 110
 111     void SetCursorAtLast()
 112     {
 113         xEntry->set_position(-1);
 114     }
 115
 116     Selection GetSelection() const
 117     {
 118         int nStartPos, nEndPos;
 119         xEntry->get_selection_bounds(nStartPos, nEndPos);
 120         return Selection(nStartPos, nEndPos);
 121     }
 122
 123     weld::Label* GetLabelWidgetForShrinkMode()
 124     {
 125         return pLabelWidget;
 126     }
 127
 128     void SaveValue()
 129     {
 130         xEntry->save_value();
 131     }
 132
 133     bool IsValueChangedFromSaved() const
 134     {
 135         return xEntry->get_value_changed_from_saved();
 136     }
 137
 138     void SetGetFocusHdl(const Link<RefEdit&,void>& rLink) { maGetFocusHdl = rLink; }
 139     void SetLoseFocusHdl(const Link<RefEdit&,void>& rLink) { maLoseFocusHdl = rLink; }
 140     void SetModifyHdl(const Link<RefEdit&,void>& rLink) { maModifyHdl = rLink; }
 141     const Link<RefEdit&,void>& GetModifyHdl() const { return maModifyHdl; }
 142     void SetActivateHdl(const Link<weld::Widget&,bool>& rLink) { maActivateHdl = rLink; }
 143 };
 144
 145 class FORMULA_DLLPUBLIC RefButton
 146 {
 147 private:
 148     std::unique_ptr<weld::Button> xButton;
 149     IControlReferenceHandler* pAnyRefDlg;   // parent dialog
 150     RefEdit*              pRefEdit;     // associated Edit-Control
 151     Link<RefButton&,void> maGetFocusHdl;
 152     Link<RefButton&,void> maLoseFocusHdl;
 153     Link<weld::Widget&,bool> maActivateHdl;
 154     Link<RefButton&,void> maClickHdl;
 155
 156     DECL_LINK(Click, weld::Button&, void);
 157     DECL_DLLPRIVATE_LINK(KeyInput, const KeyEvent&, bool);
 158     DECL_DLLPRIVATE_LINK(GetFocus, weld::Widget&, void);
 159     DECL_DLLPRIVATE_LINK(LoseFocus, weld::Widget&, void);
 160
 161 public:
 162     RefButton(std::unique_ptr<weld::Button> xControl);
 163     weld::Button* GetWidget() const { return xButton.get(); }
 164     ~RefButton();
 165     void SetReferences(IControlReferenceHandler* pDlg, RefEdit* pEdit);
 166     void SetStartImage();
 167     void SetEndImage();
 168     void DoRef()
 169     {
 170         Click(*xButton);
 171     }
 172     void SetGetFocusHdl(const Link<RefButton&,void>& rLink) { maGetFocusHdl = rLink; }
 173     void SetLoseFocusHdl(const Link<RefButton&,void>& rLink) { maLoseFocusHdl = rLink; }
 174     void SetActivateHdl(const Link<weld::Widget&,bool>& rLink) { maActivateHdl = rLink; }
 175     void SetClickHdl(const Link<RefButton&,void>& rLink) { maClickHdl = rLink; }
 176 };
 177
 178 } // formula
 179
 180 #endif // INCLUDED_FORMULA_FUNCUTL_HXX
 181
 182 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */