include/vcl/ctrl.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_VCL_CTRL_HXX
  21 #define INCLUDED_VCL_CTRL_HXX
  22
  23 #include <tools/link.hxx>
  24 #include <vcl/dllapi.h>
  25 #include <vcl/window.hxx>
  26 #include <memory>
  27
  28 // forward
  29 namespace vcl { struct ImplControlData; }
  30 class StyleSettings;
  31
  32
  33 class VCL_DLLPUBLIC Control : public vcl::Window
  34 {
  35 protected:
  36     std::unique_ptr<vcl::ImplControlData> mpControlData;
  37
  38 private:
  39     bool                    mbHasControlFocus;
  40     bool                    mbShowAccelerator;
  41     Link<Control&,void>     maLoseFocusHdl;
  42
  43     SAL_DLLPRIVATE void     ImplInitControlData();
  44
  45                             Control (const Control &) = delete;
  46                             Control & operator= (const Control &) = delete;
  47
  48 protected:
  49                     Control( WindowType nType );
  50     virtual void    FillLayoutData() const;
  51
  52     // helper method for composite controls
  53     void            AppendLayoutData( const Control& rSubControl ) const;
  54
  55     /// creates the mpData->mpLayoutData structure
  56     void            CreateLayoutData() const;
  57     /// determines whether we currently have layout data
  58     bool            HasLayoutData() const;
  59
  60     /** this calls both our event listeners, and a specified handler
  61
  62         If the Control instance is destroyed during any of those calls, the
  63         method properly handles this (in particular, it doesn't crash :)
  64
  65         @param nEvent
  66             the event to notify to our event listeners
  67         @param callHandler
  68             the lambda function that calls the handler
  69         @return
  70             if the Control instance has been destroyed in any of the call
  71     */
  72     bool        ImplCallEventListenersAndHandler(
  73                     VclEventId nEvent, std::function<void()> const & callHandler
  74                 );
  75
  76     void        CallEventListeners( VclEventId nEvent, void* pData = nullptr );
  77
  78     /** draws the given text onto the given device
  79
  80         If no reference device is set, the draw request will simply be forwarded to OutputDevice::DrawText. Otherwise,
  81         the text will be rendered according to the metrics at the reference device.
  82
  83         return will contain the result of a GetTextRect call (either directly
  84         at the target device, or taking the reference device into account) when
  85         returning.
  86     */
  87     tools::Rectangle DrawControlText( OutputDevice& _rTargetDevice, const tools::Rectangle& _rRect,
  88                                const OUString& _rStr, DrawTextFlags _nStyle,
  89                                MetricVector* _pVector, OUString* _pDisplayText,
  90                                const Size* i_pDeviceSize = nullptr ) const;
  91
  92     tools::Rectangle GetControlTextRect( OutputDevice& _rTargetDevice, const tools::Rectangle & rRect,
  93                                   const OUString& _rStr, DrawTextFlags _nStyle,
  94                                   Size* o_pDeviceSize = nullptr ) const;
  95
  96     virtual const vcl::Font&
  97                 GetCanonicalFont( const StyleSettings& _rStyle ) const;
  98     virtual const Color&
  99                 GetCanonicalTextColor( const StyleSettings& _rStyle ) const;
 100
 101     void ImplInitSettings();
 102
 103     virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
 104
 105 public:
 106     SAL_DLLPRIVATE void ImplClearLayoutData() const;
 107     /** draws a frame around the give rectangle, onto the given device
 108
 109         only to be used from within the Window::Draw method of your sub class.
 110
 111         The frame is always drawn with a single line (without 3D effects). In addition, any mono
 112         color set at the control's settings is respected. Yet more additionally, if we're living
 113         in a themed desktop, this theming is ignored.
 114
 115         Note that this makes sense, since the *only known* clients of Window::Draw
 116         are form controls, when printed or print-previewed. For form controls embedded in office documents,
 117         you don't want to have the theme look.
 118
 119         @param pDev
 120             the device to draw onto
 121         @param rRect
 122             the rect for drawing the frame. Upon returning from the call, the rect will be inflated
 123             by the space occupied by the drawn pixels.
 124     */
 125     SAL_DLLPRIVATE void ImplDrawFrame( OutputDevice* pDev, tools::Rectangle& rRect );
 126
 127 public:
 128     explicit        Control( vcl::Window* pParent, WinBits nWinStyle = 0 );
 129     virtual         ~Control() override;
 130     virtual void    dispose() override;
 131
 132     virtual void    EnableRTL ( bool bEnable = true ) override;
 133
 134     virtual bool    EventNotify( NotifyEvent& rNEvt ) override;
 135     virtual void    StateChanged( StateChangedType nStateChange ) override;
 136     virtual void    Resize() override;
 137
 138     // invalidates layout data
 139     virtual void    SetText( const OUString& rStr ) override;
 140     // gets the displayed text
 141     virtual OUString GetDisplayText() const override;
 142     // returns the bounding box for the character at index nIndex (in control coordinates)
 143     tools::Rectangle GetCharacterBounds( tools::Long nIndex ) const;
 144     // returns the character index for corresponding to rPoint (in control coordinates)
 145     // -1 is returned if no character is at that point
 146     tools::Long GetIndexForPoint( const Point& rPoint ) const;
 147     // returns the interval [start,end] of line nLine
 148     // returns [-1,-1] for an invalid line
 149     Pair GetLineStartEnd( tools::Long nLine ) const;
 150     /** ToRelativeLineIndex changes a layout data index to a count relative to its line.
 151
 152     This is equivalent to getting the line start/end pairs with
 153     GetLineStartEnd() until the index lies within [start,end] of a line
 154
 155     @param nIndex
 156     the absolute index inside the display text to be changed to a relative index
 157
 158     @returns
 159     the relative index inside the displayed line or -1 if the absolute index does
 160     not match any line
 161     */
 162     tools::Long ToRelativeLineIndex( tools::Long nIndex ) const;
 163
 164     void            SetLoseFocusHdl( const Link<Control&,void>& rLink ) { maLoseFocusHdl = rLink; }
 165
 166     /** determines whether the control currently has the focus
 167     */
 168     bool            HasControlFocus() const { return mbHasControlFocus; }
 169
 170     void            SetLayoutDataParent( const Control* pParent ) const;
 171
 172     virtual Size    GetOptimalSize() const override;
 173
 174     /** sets a reference device used for rendering control text
 175         @see DrawControlText
 176     */
 177     void            SetReferenceDevice( OutputDevice* _referenceDevice );
 178     OutputDevice*   GetReferenceDevice() const;
 179
 180     vcl::Font       GetUnzoomedControlPointFont() const;
 181     void            SetShowAccelerator (bool val);
 182
 183     void LogicMouseButtonDown(const MouseEvent& rMouseEvent) override;
 184     void LogicMouseButtonUp(const MouseEvent& rMouseEvent) override;
 185     void LogicMouseMove(const MouseEvent& rMouseEvent) override;
 186 };
 187
 188 #endif // INCLUDED_VCL_CTRL_HXX
 189
 190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */