/* -*- 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 "ViewShell.hxx"

#include <svx/svdview.hxx>

#include <pres.hxx>

class SdDrawDocument;

class SdOptions;

namespace sd {

/**

 * View for MDIFrame

 */

class FrameView final

    : public SdrView

{

public:

    FrameView(SdDrawDocument* pDrawDoc, FrameView* pFrameView = nullptr );

    FrameView(const FrameView& rFrameView);

    virtual ~FrameView() override;

    void Connect();

    void Disconnect();

    void Update(SdOptions const * pOptions);

    void  SetStandardHelpLines(const SdrHelpLineList& rHelpLines)

                             { maStandardHelpLines = rHelpLines; }

    const SdrHelpLineList& GetStandardHelpLines() const { return maStandardHelpLines; }

    void  SetNotesHelpLines(const SdrHelpLineList& rHelpLines)

                             { maNotesHelpLines = rHelpLines; }

    const SdrHelpLineList& GetNotesHelpLines() const { return maNotesHelpLines; }

    void  SetHandoutHelpLines(const SdrHelpLineList& rHelpLines)

                             { maHandoutHelpLines = rHelpLines; }

    const SdrHelpLineList& GetHandoutHelpLines() const { return maHandoutHelpLines; }

    void SetVisibleLayers(const SdrLayerIDSet& rVisibleLayers)

                         { maVisibleLayers = rVisibleLayers; }

    const SdrLayerIDSet& GetVisibleLayers() const { return maVisibleLayers; }

    void SetLockedLayers(const SdrLayerIDSet& rLockedLayers)

                        { maLockedLayers = rLockedLayers; }

    const SdrLayerIDSet& GetLockedLayers() const { return maLockedLayers; }

    void SetPrintableLayers(const SdrLayerIDSet& rPrintableLayers)

                         { maPrintableLayers = rPrintableLayers; }

    const SdrLayerIDSet& GetPrintableLayers() const { return maPrintableLayers; }

    void SetRuler(const bool bRulerOn)

                 { mbRuler = bRulerOn; }

    bool HasRuler() const { return mbRuler; }

    void SetNoColors(const bool bNoCol)

                 { mbNoColors = bNoCol; }

    bool IsNoColors() const { return mbNoColors; }

    void SetNoAttribs(const bool bNoAttr)

                 { mbNoAttribs = bNoAttr; }

    bool IsNoAttribs() const { return mbNoAttribs; }

    void SetVisArea(const ::tools::Rectangle& rVisArea)

                 { maVisArea = rVisArea; }

    const ::tools::Rectangle& GetVisArea() const { return maVisArea; }

    void SetPageKind(PageKind eKind) { mePageKind = eKind; }

    PageKind GetPageKind() const { return mePageKind; }

    /** is used in FrameView::ReadUserDataSequence() only to store the

        page kind that was selected while last saving this document */

    void SetPageKindOnLoad(PageKind eKind) { mePageKindOnLoad = eKind; }

    /** can be used to get the page kind that was selected on last save of this document */

    PageKind GetPageKindOnLoad() const { return mePageKindOnLoad; }

    void SetSelectedPage (sal_uInt16 nPage);

    sal_uInt16 GetSelectedPage () const { return mnSelectedPage;}

    /** is used in FrameView::ReadUserDataSequence() only to store the

        page that was selected while last saving this document */

    void SetSelectedPageOnLoad (sal_uInt16 nPage) { mnSelectedPageOnLoad = nPage; }

    /** can be used to get the page that was selected on last save of this document */

    sal_uInt16 GetSelectedPageOnLoad () const { return mnSelectedPageOnLoad; }

    void SetViewShEditMode(EditMode eMode);

    EditMode GetViewShEditMode () const;

    /** Remember the edit mode of the main view shell at the time when the

        document is loaded.

    */

    void SetViewShEditModeOnLoad (const EditMode eMode);

    /** Return the value of the edit mode as it was when the document was

        loaded.

    */

    EditMode GetViewShEditModeOnLoad() const { return meEditModeOnLoad;}

    void SetLayerMode(bool bMode)

                 { mbLayerMode = bMode; }

    bool IsLayerMode() const { return mbLayerMode; }

    void SetQuickEdit(bool bQEdit)

                 { mbQuickEdit = bQEdit; }

    bool IsQuickEdit() const { return mbQuickEdit; }

    void        SetDoubleClickTextEdit( bool bOn ) { mbDoubleClickTextEdit = bOn; }

    bool    IsDoubleClickTextEdit() const { return mbDoubleClickTextEdit; }

    void        SetClickChangeRotation( bool bOn ) { mbClickChangeRotation = bOn; }

    bool    IsClickChangeRotation() const { return mbClickChangeRotation; }

    /** Remember the type of the view shell that was (or soon will be)

        previously associated with this frame view.

        @param eType

            The type of the previous view shell or ViewShell::ST_NONE to

            indicate that there is no previous view shell.

    */

    void SetPreviousViewShellType (ViewShell::ShellType eType);

    /** Return the type of the view shell previously associated with this

        frame view.

    */

    ViewShell::ShellType GetPreviousViewShellType() const { return mePreviousViewShellType;}

    /** Remember the type of the view shell at the time when the document is

        loaded or, rather, when the ViewShellBase is constructed.

    */

    void SetViewShellTypeOnLoad (ViewShell::ShellType eType);

    ViewShell::ShellType GetViewShellTypeOnLoad() const { return meViewShellTypeOnLoad;}

    void SetPresentationViewShellId(sal_uInt16 nId)

                 { mnPresViewShellId = nId; }

    sal_uInt16 GetPresentationViewShellId() const { return mnPresViewShellId; }

    void SetSlidesPerRow(sal_uInt16 nSlides) { mnSlidesPerRow = nSlides; }

    sal_uInt16 GetSlidesPerRow() const { return mnSlidesPerRow; }

    void SetDrawMode(DrawModeFlags nNewDrawMode) { mnDrawMode = nNewDrawMode; };

    DrawModeFlags GetDrawMode() const { return mnDrawMode; };

    void SetIsNavigatorShowingAllShapes (const bool bIsNavigatorShowingAllShapes);

    bool IsNavigatorShowingAllShapes() const { return mbIsNavigatorShowingAllShapes;}

    void    WriteUserDataSequence ( css::uno::Sequence < css::beans::PropertyValue >& );

    void    ReadUserDataSequence ( const css::uno::Sequence < css::beans::PropertyValue >& );

private:

    sal_uInt16          mnRefCount;

    bool                mbRuler;

    SdrLayerIDSet           maVisibleLayers;

    SdrLayerIDSet           maLockedLayers;

    SdrLayerIDSet           maPrintableLayers;

    SdrHelpLineList     maStandardHelpLines;

    SdrHelpLineList     maNotesHelpLines;

    SdrHelpLineList     maHandoutHelpLines;

    bool                mbNoColors;        ///< structuring mode

    bool                mbNoAttribs;       ///< structuring mode

    ::tools::Rectangle           maVisArea;         ///< visible area

    PageKind            mePageKind;        ///< kind of page (standard, notes, handout)

    sal_uInt16          mnSelectedPage;

    PageKind            mePageKindOnLoad;

    sal_uInt16          mnSelectedPageOnLoad;

    EditMode            mePageEditMode; ///< edit mode in drawing mode (Page/MasterPage)

    // EditMode            meStandardEditMode; ///< edit mode in drawing mode (Page/MasterPage)

    // EditMode            meNotesEditMode;    ///< edit mode in notes mode (Page/MasterPage)

    // EditMode            meHandoutEditMode;  ///< edit mode in handout mode (Page/MasterPage)

    EditMode            meEditModeOnLoad;

    bool                mbLayerMode;        ///< layer on/off

    bool                mbQuickEdit;        ///< QuickEdit on/off

    bool                mbDoubleClickTextEdit; ///< text mode after double click

    bool                mbClickChangeRotation; ///< single click switches between selection/rotation mode

    sal_uInt16          mnPresViewShellId;  ///< ViewShell from which the presentation was started

    sal_uInt16          mnSlidesPerRow;     ///< slides per row on the slide-desk

    DrawModeFlags       mnDrawMode;         ///< draw mode for the normal window

    /** Remember whether the navigator shows all shapes (<TRUE/>) or only

        the names ones (<FALSE/>).  Not persistent.

    */

    bool            mbIsNavigatorShowingAllShapes;

    /** The type of the previous view shell.  The (default) value

        ViewShell::ST_NONE indicates that there was no previous view shell.

        Note that this value is used only temporarily and is not saved or

        restored.

    */

    ViewShell::ShellType mePreviousViewShellType;

    ViewShell::ShellType meViewShellTypeOnLoad;

};

} // end of namespace sd

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