SlsFocusManager.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 <sal/types.h>
#include <tools/link.hxx>
#include <vector>
 
namespace sd::slidesorter
{
class SlideSorter;
}
 
namespace sd::slidesorter::controller
{
class FocusManager
{
public:
    FocusManager(SlideSorter& rSlideSorter);
 
    ~FocusManager();
 
    enum class FocusMoveDirection
    {
        Left,
        Right,
        Up,
        Down
    };
 
    void MoveFocus(FocusMoveDirection eDirection);
 
    void ShowFocus(const bool bScrollToFocus = true);
 
    void HideFocus();
 
    bool ToggleFocus();
 
    bool HasFocus() const;
 
    model::SharedPageDescriptor GetFocusedPageDescriptor() const;
 
    sal_Int32 GetFocusedPageIndex() const { return mnPageIndex; }
 
    bool SetFocusedPage(const model::SharedPageDescriptor& rDescriptor);
 
    void SetFocusedPage(sal_Int32 nPageIndex);
 
    bool SetFocusedPageFromCurrentPage();
 
    bool IsFocusShowing() const;
 
    void AddFocusChangeListener(const Link<LinkParamNone*, void>& rListener);
 
    void RemoveFocusChangeListener(const Link<LinkParamNone*, void>& rListener);
 
    class FocusHider
    {
    public:
        FocusHider(FocusManager&);
        ~FocusHider() COVERITY_NOEXCEPT_FALSE;
 
    private:
        bool mbFocusVisible;
        FocusManager& mrManager;
    };
 
private:
    SlideSorter& mrSlideSorter;
 
    sal_Int32 mnPageIndex;
 
    bool mbPageIsFocused;
 
    ::std::vector<Link<LinkParamNone*, void>> maFocusChangeListeners;
 
    void HideFocusIndicator(const model::SharedPageDescriptor& rpDescriptor);
 
    void ShowFocusIndicator(const model::SharedPageDescriptor& rpDescriptor,
                            const bool bScrollToFocus);
 
    void NotifyFocusChangeListeners() const;
};
 
} // end of namespace ::sd::slidesorter::controller
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */