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