libreoffice/basctl/source/inc/dlged.hxx

/* -*- 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 .
 */

#pragma once

#include <com/sun/star/awt/XControlContainer.hpp>
#include <com/sun/star/container/XNameContainer.hpp>
#include <com/sun/star/datatransfer/DataFlavor.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/util/XNumberFormatsSupplier.hpp>
#include <o3tl/deleter.hxx>
#include <svl/SfxBroadcaster.hxx>
#include <svl/hint.hxx>
#include <svx/svdobjkind.hxx>
#include <tools/gen.hxx>
#include <vcl/timer.hxx>
#include <vcl/idle.hxx>
#include <vcl/vclptr.hxx>
#include <vcl/window.hxx>

#include <memory>

class ScrollAdaptor;
class Printer;
class KeyEvent;
class MouseEvent;
class Timer;
namespace vcl { class Window; }

namespace basctl
{

class DialogWindowLayout;

constexpr auto DLGED_PAGE_WIDTH_MIN = 1280;
constexpr auto DLGED_PAGE_HEIGHT_MIN = 1024;

// DlgEdHint


class DlgEdObj;

class DlgEdHint: public SfxHint
{
public:
    enum Kind {
        UNKNOWN,
        WINDOWSCROLLED,
        LAYERCHANGED,
        OBJORDERCHANGED,
        SELECTIONCHANGED,
    };

private:
    Kind       eKind;
    DlgEdObj*  pDlgEdObj;

public:
    DlgEdHint (Kind);
    DlgEdHint (Kind, DlgEdObj* pObj);
    virtual ~DlgEdHint() override;

    Kind       GetKind() const { return eKind; }
    DlgEdObj*  GetObject() const { return pDlgEdObj; }
};


// DlgEditor


class DlgEdModel;
class DlgEdPage;
class DlgEdView;
class DlgEdForm;
class DlgEdFactory;
class DlgEdFunc;

class DlgEditor: public SfxBroadcaster
{
public:
    enum Mode {
        INSERT,
        SELECT,
        TEST,
        READONLY,
    };

private:
    DECL_LINK(MarkTimeout, Timer *, void);

    static void Print( Printer* pPrinter, const OUString& rTitle );

private:
    VclPtr<ScrollAdaptor>      pHScroll;
    VclPtr<ScrollAdaptor>      pVScroll;
    std::unique_ptr<DlgEdModel> pDlgEdModel; // never nullptr
    DlgEdPage*          pDlgEdPage;  // never nullptr
    std::unique_ptr<DlgEdView> pDlgEdView; // never nullptr
    rtl::Reference<DlgEdForm>  pDlgEdForm; // never nullptr
    css::uno::Reference< css::container::XNameContainer >     m_xUnoControlDialogModel;
    css::uno::Reference< css::awt::XControlContainer >        m_xControlContainer;
    css::uno::Sequence< css::datatransfer::DataFlavor >       m_ClipboardDataFlavors;
    css::uno::Sequence< css::datatransfer::DataFlavor >       m_ClipboardDataFlavorsResource;
    css::uno::Reference< css::util::XNumberFormatsSupplier >  m_xSupplier;
    std::unique_ptr<DlgEdFactory, o3tl::default_delete<DlgEdFactory>> pObjFac; // never nullptr
    vcl::Window&                    rWindow; // DialogWindow
    std::unique_ptr<DlgEdFunc>    pFunc;
    DialogWindowLayout& rLayout;
    Mode                eMode;
    SdrObjKind          eActObj;
    bool                bFirstDraw;
    bool                bCreateOK;
    tools::Rectangle           aPaintRect;
    bool                bDialogModelChanged;
    Idle                aMarkIdle;
    tools::Long                mnPaintGuard;
    css::uno::Reference< css::frame::XModel > m_xDocument;

public:
    DlgEditor (
        vcl::Window&, DialogWindowLayout&,
        css::uno::Reference<css::frame::XModel> const& xModel,
        css::uno::Reference<css::container::XNameContainer> const & xDialogModel
    );
    virtual ~DlgEditor() override;

    vcl::Window& GetWindow() const { return rWindow; }

    /** returns the control container associated with our window
        @see GetWindow
        @see SetWindow
    */
    css::uno::Reference< css::awt::XControlContainer > const &
                    GetWindowControlContainer();

    void            SetScrollBars(ScrollAdaptor* pHScroll, ScrollAdaptor* pVScroll);
    void            InitScrollBars();
    ScrollAdaptor*  GetHScroll() const { return pHScroll; }
    ScrollAdaptor*  GetVScroll() const { return pVScroll; }
    void            DoScroll();
    void            UpdateScrollBars();

    void            SetDialog (const css::uno::Reference<css::container::XNameContainer>& xUnoControlDialogModel);
    void            ResetDialog ();
    const css::uno::Reference< css::container::XNameContainer >& GetDialog() const
                        {return m_xUnoControlDialogModel;}

    css::uno::Reference< css::util::XNumberFormatsSupplier > const & GetNumberFormatsSupplier();

    DlgEdModel&     GetModel()      const { return *pDlgEdModel; }
    DlgEdView&      GetView()       const { return *pDlgEdView; }
    DlgEdPage&      GetPage()       const { return *pDlgEdPage; }

    void            ShowDialog();

    bool            UnmarkDialog();
    bool            RemarkDialog();

    void            SetDialogModelChanged() { bDialogModelChanged = true; }

    bool            IsModified () const;
    void            ClearModifyFlag();

    void            MouseButtonDown( const MouseEvent& rMEvt );
    void            MouseButtonUp( const MouseEvent& rMEvt );
    void            MouseMove( const MouseEvent& rMEvt );
    void            Paint(vcl::RenderContext& rRenderContext, const tools::Rectangle& rRect);
    bool            KeyInput( const KeyEvent& rKEvt );

    void            SetMode (Mode eMode);
    void            SetInsertObj(SdrObjKind eObj);
    void            CreateDefaultObject();
    Mode            GetMode() const { return eMode; }
    bool            IsCreateOK() const { return bCreateOK; }

    void            Cut();
    void            Copy();
    void            Paste();
    void            Delete();
    bool            IsPasteAllowed();

    void            ShowProperties();
    void            UpdatePropertyBrowserDelayed();

    static void     printPage( sal_Int32 nPage, Printer* pPrinter, const OUString& );

    bool            AdjustPageSize();

    bool            isInPaint() const { return mnPaintGuard > 0; }
};

} // namespace basctl

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */