SlsPageSelector.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 .
 */
 
#pragma once
 
#include <model/SlsSharedPageDescriptor.hxx>
 
#include <vector>
#include <memory>
 
#include <sddllapi.h>
 
class SdPage;
 
namespace sd::slidesorter
{
class SlideSorter;
}
namespace sd::slidesorter::model
{
class SlideSorterModel;
}
 
namespace sd::slidesorter::controller
{
class SlideSorterController;
 
class PageSelector
{
public:
    explicit PageSelector(SlideSorter& rSlideSorter);
    PageSelector(const PageSelector&) = delete;
    PageSelector& operator=(const PageSelector&) = delete;
 
    // Exported for unit test
    SD_DLLPUBLIC void SelectAllPages();
    SD_DLLPUBLIC void DeselectAllPages();
 
    void GetCoreSelection();
 
    void SetCoreSelection();
 
    void SelectPage(int nPageIndex);
    void SelectPage(const SdPage* pPage);
    void SelectPage(const model::SharedPageDescriptor& rpDescriptor);
 
    SD_DLLPUBLIC bool IsPageSelected(int nPageIndex);
 
    SD_DLLPUBLIC bool IsPageExcluded(int nPageIndex);
 
    void DeselectPage(int nPageIndex);
    void DeselectPage(const model::SharedPageDescriptor& rpDescriptor,
                      const bool bUpdateCurrentPage = true);
 
    int GetPageCount() const;
    int GetSelectedPageCount() const { return mnSelectedPageCount; }
 
    const model::SharedPageDescriptor& GetSelectionAnchor() const { return mpSelectionAnchor; }
 
    typedef ::std::vector<SdPage*> PageSelection;
 
    std::shared_ptr<PageSelection> GetPageSelection() const;
 
    void SetPageSelection(const std::shared_ptr<PageSelection>& rSelection,
                          const bool bUpdateCurrentPage);
 
    void CountSelectedPages();
 
    class UpdateLock
    {
    public:
        UpdateLock(SlideSorter const& rSlideSorter);
        UpdateLock(PageSelector& rPageSelector);
        ~UpdateLock();
        void Release();
 
    private:
        PageSelector* mpSelector;
    };
 
    class BroadcastLock
    {
    public:
        BroadcastLock(SlideSorter const& rSlideSorter);
        BroadcastLock(PageSelector& rPageSelector);
        ~BroadcastLock();
 
    private:
        PageSelector& mrSelector;
    };
 
private:
    model::SlideSorterModel& mrModel;
    SlideSorter& mrSlideSorter;
    SlideSorterController& mrController;
    int mnSelectedPageCount;
    int mnBroadcastDisableLevel;
    bool mbSelectionChangeBroadcastPending;
    model::SharedPageDescriptor mpMostRecentlySelectedPage;
    model::SharedPageDescriptor mpSelectionAnchor;
    sal_Int32 mnUpdateLockCount;
    bool mbIsUpdateCurrentPagePending;
 
    void EnableBroadcasting();
 
    void DisableBroadcasting();
 
    void UpdateCurrentPage(const bool bUpdateOnlyWhenPending = false);
 
    void CheckConsistency() const;
};
 
} // end of namespace ::sd::slidesorter::controller
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */