SlsLayouter.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 <vcl/vclptr.hxx>
#include <tools/gen.hxx>
#include <sal/types.h>
#include <memory>
 
namespace sd { class Window; }
namespace sd::slidesorter::model { class SlideSorterModel; }
namespace sd::slidesorter::view { class PageObjectLayouter; }
namespace sd::slidesorter::view { class Theme; }
 
namespace sd::slidesorter::view {
 
class InsertPosition;
 
class Layouter
{
public:
    enum Orientation { HORIZONTAL, VERTICAL, GRID };
 
    Layouter (
        sd::Window *rpWindow,
        const std::shared_ptr<Theme>& rpTheme);
    ~Layouter();
 
    std::shared_ptr<PageObjectLayouter> const & GetPageObjectLayouter() const;
    void SetColumnCount (sal_Int32 nMinimalColumnCount,
        sal_Int32 nMaximalColumnCount);
 
    bool Rearrange (
        const Orientation eOrientation,
        const Size& rWindowSize,
        const Size& rPreviewModelSize,
        const sal_uInt32 nPageCount);
 
    sal_Int32 GetColumnCount() const;
 
    sal_Int32 GetIndex (const sal_Int32 nRow, const sal_Int32 nColumn) const;
 
    Size const & GetPageObjectSize() const;
 
    ::tools::Rectangle GetPageObjectBox (
        const sal_Int32 nIndex,
        const bool bIncludeBorderAndGap) const;
 
    ::tools::Rectangle GetTotalBoundingBox() const;
 
    Range GetRangeOfVisiblePageObjects (const ::tools::Rectangle& rVisibleArea) const;
 
    sal_Int32 GetIndexAtPoint (
        const Point& rModelPosition,
        const bool bIncludePageBorders,
        const bool bClampToValidRange = true) const;
 
    InsertPosition GetInsertPosition (
        const Point& rModelPosition,
        const Size& rIndicatorSize,
        model::SlideSorterModel const & rModel) const;
 
    Range GetValidHorizontalSizeRange() const;
    Range GetValidVerticalSizeRange() const;
 
    class Implementation;
 
private:
    std::unique_ptr<Implementation> mpImplementation;
    VclPtr<sd::Window> mpWindow;
};
 
class InsertPosition
{
public:
    InsertPosition();
    bool operator== (const InsertPosition& rInsertPosition) const;
    bool operator!= (const InsertPosition& rInsertPosition) const;
 
    void SetLogicalPosition (
        const sal_Int32 nRow,
        const sal_Int32 nColumn,
        const sal_Int32 nIndex,
        const bool bIsAtRunStart,
        const bool bIsAtRunEnd,
        const bool bIsExtraSpaceNeeded);
    void SetGeometricalPosition(
        const Point& rLocation,
        const Point& rLeadingOffset,
        const Point& rTrailingOffset);
 
    sal_Int32 GetRow() const { return mnRow; }
    sal_Int32 GetColumn() const { return mnColumn; }
    sal_Int32 GetIndex() const { return mnIndex; }
    const Point& GetLocation() const { return maLocation; }
    const Point& GetLeadingOffset() const { return maLeadingOffset; }
    const Point& GetTrailingOffset() const { return maTrailingOffset; }
    bool IsAtRunStart() const { return mbIsAtRunStart; }
    bool IsAtRunEnd() const { return mbIsAtRunEnd; }
    bool IsExtraSpaceNeeded() const { return mbIsExtraSpaceNeeded; }
 
private:
    sal_Int32 mnRow;
    sal_Int32 mnColumn;
    sal_Int32 mnIndex;
    bool mbIsAtRunStart : 1;
    bool mbIsAtRunEnd : 1;
    bool mbIsExtraSpaceNeeded : 1;
    Point maLocation;
    Point maLeadingOffset;
    Point maTrailingOffset;
};
 
} // end of namespace ::sd::slidesorter::view
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */