ctrl.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#ifndef INCLUDED_VCL_CTRL_HXX
#define INCLUDED_VCL_CTRL_HXX
 
#include <rtl/ustring.hxx>
#include <tools/link.hxx>
#include <tools/gen.hxx>
#include <vcl/dllapi.h>
#include <vcl/window.hxx>
#include <optional>
#include <vector>
 
// forward
class StyleSettings;
class Control;
 
namespace vcl
{
 
struct VCL_DLLPUBLIC ControlLayoutData
{
    // contains the string really displayed
    // there must be exactly one bounding rectangle in m_aUnicodeBoundRects
    // for every character in m_aDisplayText
    OUString                            m_aDisplayText;
    // the bounding rectangle of every character
    // where one character may consist of many glyphs
    std::vector< tools::Rectangle >            m_aUnicodeBoundRects;
    // start indices of lines
    std::vector< tools::Long >                 m_aLineIndices;
    // notify parent control on destruction
    VclPtr<const Control>               m_pParent;
 
    ControlLayoutData();
    ~ControlLayoutData();
 
    tools::Rectangle GetCharacterBounds( tools::Long nIndex ) const;
    // returns the character index for corresponding to rPoint (in control coordinates)
    // -1 is returned if no character is at that point
    tools::Long GetIndexForPoint( const Point& rPoint ) const;
    // returns the number of lines in the result of GetDisplayText()
    tools::Long GetLineCount() const;
    // returns the interval [start,end] of line nLine
    // returns [-1,-1] for an invalid line
    ::Pair GetLineStartEnd( tools::Long nLine ) const;
    tools::Long ToRelativeLineIndex( tools::Long nIndex ) const;
};
 
} // namespace vcl
 
class VCL_DLLPUBLIC Control : public vcl::Window
{
protected:
    mutable std::optional<vcl::ControlLayoutData>  mxLayoutData;
    VclPtr<OutputDevice>        mpReferenceDevice;
 
private:
    bool                    mbHasControlFocus;
    bool                    mbShowAccelerator;
    Link<Control&,void>     maLoseFocusHdl;
 
    SAL_DLLPRIVATE void     ImplInitControlData();
 
                            Control (const Control &) = delete;
                            Control & operator= (const Control &) = delete;
 
protected:
                    Control( WindowType nType );
    virtual void    FillLayoutData() const;
 
    // helper method for composite controls
    void            AppendLayoutData( const Control& rSubControl ) const;
 
    void            CreateLayoutData() const;
    bool            HasLayoutData() const;
 
    bool        ImplCallEventListenersAndHandler(
                    VclEventId nEvent, std::function<void()> const & callHandler
                );
 
    void        CallEventListeners( VclEventId nEvent, void* pData = nullptr );
 
    tools::Rectangle DrawControlText( OutputDevice& _rTargetDevice, const tools::Rectangle& _rRect,
                               const OUString& _rStr, DrawTextFlags _nStyle,
                               std::vector< tools::Rectangle >* _pVector, OUString* _pDisplayText,
                               const Size* i_pDeviceSize = nullptr ) const;
 
    tools::Rectangle GetControlTextRect( OutputDevice& _rTargetDevice, const tools::Rectangle & rRect,
                                  const OUString& _rStr, DrawTextFlags _nStyle,
                                  Size* o_pDeviceSize = nullptr ) const;
 
    virtual const vcl::Font&
                GetCanonicalFont( const StyleSettings& _rStyle ) const;
    virtual const Color&
                GetCanonicalTextColor( const StyleSettings& _rStyle ) const;
 
    void ImplInitSettings();
 
    virtual void ApplySettings(vcl::RenderContext& rRenderContext) override;
 
public:
    SAL_DLLPRIVATE void ImplClearLayoutData() const;
    SAL_DLLPRIVATE void ImplDrawFrame( OutputDevice* pDev, tools::Rectangle& rRect );
 
public:
    explicit        Control( vcl::Window* pParent, WinBits nWinStyle = 0 );
    virtual         ~Control() override;
    virtual void    dispose() override;
 
    virtual void    EnableRTL ( bool bEnable = true ) override;
 
    virtual bool    EventNotify( NotifyEvent& rNEvt ) override;
    virtual void    StateChanged( StateChangedType nStateChange ) override;
    virtual void    Resize() override;
 
    // invalidates layout data
    virtual void    SetText( const OUString& rStr ) override;
    // gets the displayed text
    virtual OUString GetDisplayText() const override;
    // returns the bounding box for the character at index nIndex (in control coordinates)
    tools::Rectangle GetCharacterBounds( tools::Long nIndex ) const;
    // returns the character index for corresponding to rPoint (in control coordinates)
    // -1 is returned if no character is at that point
    tools::Long GetIndexForPoint( const Point& rPoint ) const;
    // returns the interval [start,end] of line nLine
    // returns [-1,-1] for an invalid line
    Pair GetLineStartEnd( tools::Long nLine ) const;
    tools::Long ToRelativeLineIndex( tools::Long nIndex ) const;
 
    void            SetLoseFocusHdl( const Link<Control&,void>& rLink ) { maLoseFocusHdl = rLink; }
 
    bool            HasControlFocus() const { return mbHasControlFocus; }
 
    void            SetLayoutDataParent( const Control* pParent ) const;
 
    virtual Size    GetOptimalSize() const override;
 
    void            SetReferenceDevice( OutputDevice* _referenceDevice );
    OutputDevice*   GetReferenceDevice() const;
 
    vcl::Font       GetUnzoomedControlPointFont() const;
    void            SetShowAccelerator (bool val);
};
 
#endif // INCLUDED_VCL_CTRL_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */