Differential D22034 Diff 61786 components/containmentlayoutmanager/abstractlayoutmanager.h

Changeset View

Standalone View

components/containmentlayoutmanager/abstractlayoutmanager.h

This file was added.

1		/*
2		* Copyright 2019 by Marco Martin <mart@kde.org>
3		*
4		* This program is free software; you can redistribute it and/or modify
5		* it under the terms of the GNU Library General Public License as
6		* published by the Free Software Foundation; either version 2, or
7		* (at your option) any later version.
8		*
9		* This program is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU Library General Public License for more details
13		*
14		* You should have received a copy of the GNU Library General Public
15		* License along with this program; if not, write to the
16		* Free Software Foundation, Inc.,
17		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18		*
19		*/
20
21		#pragma once
22
23		#include <QObject>
24		#include "appletslayout.h"
25
26		class ItemContainer;
27
28		class AbstractLayoutManager : public QObject
29		{
30		Q_OBJECT
31
32		public:
33		AbstractLayoutManager(AppletsLayout *layout);
34		~AbstractLayoutManager();
35
36		AppletsLayout *layout() const;
37
38		void setCellSize(const QSizeF &size);
39		QSizeF cellSize() const;
40
41		/**
42		* A size aligned to the gid that fully contains the given size
43		*/
44		QSizeF cellAlignedContainingSize(const QSizeF &size) const;
	davidedmundsonUnsubmitted Not Done I don't fully understand the split between AbstractLayoutManager and GridLayoutManager when AbstractLayoutManager effectively enforces a grid by having cell sizes. davidedmundson: I don't fully understand the split between AbstractLayoutManager and GridLayoutManager when…
	martAuthorUnsubmitted Not Done in the end it needed cell sizes to be directly exposed to qml. tough the idea was to leave space for eventual future different layouts like linear, or still grid but with a different strategy and so on mart: in the end it needed cell sizes to be directly exposed to qml. tough the idea was to leave…
45
46		/**
47		* Positions the item, does not assign the space as taken
48		*/
49		void positionItem(ItemContainer *item);
50
51		/**
52		* Positions the item and assigns the space as taken by this item
53		*/
54		void positionItemAndAssign(ItemContainer *item);
55
56		/**
57		* Set the space of item's rect as occupied by item.
58		* The operation may fail if some space of the item's geometry is already occupied.
59		* @returns true if the operation succeeded
60		*/
61		bool assignSpace(ItemContainer *item);
62
63		/**
64		* If item is occupying space, set it as available
65		*/
66		void releaseSpace(ItemContainer *item);
67
68		// VIRTUALS
69		virtual QString serializeLayout() const = 0;
70
71		virtual void parseLayout(const QString &savedLayout) = 0;
72
73		virtual void layoutGeometryChanged(const QRectF &newGeometry, const QRectF &oldGeometry);
74
75		/**
76		* true if the item is managed by the grid
77		*/
78		virtual bool itemIsManaged(ItemContainer *item) = 0;
79
80		/**
81		* Forget about layout information and relayout all items based solely on their current geometry
82		*/
83		virtual void resetLayout() = 0;
84
85		/**
86		* Forget about layout information and relayout all items based on their stored geometry first, and if that fails from their current geometry
87		*/
88		virtual void resetLayoutFromConfig() = 0;
89
90		/**
91		* Restores an item geometry from the serialized config
92		* parseLayout needs to be called before this
93		* @returns true if the item was stored in the config
94		* and the restore has been performed.
95		* Otherwise, the item is not touched and returns false
96		*/
97		virtual bool restoreItem(ItemContainer *item) = 0;
98
99		/**
100		* @returns true if the given rectangle is all free space
101		*/
102		virtual bool isRectAvailable(const QRectF &rect) = 0;
103
104		Q_SIGNALS:
105		/**
106		* Emitted when the layout has been changed and now needs saving
107		*/
108		void layoutNeedsSaving();
109
110		protected:
111		/**
112		* Subclasses implement their assignSpace logic here
113		*/
114		virtual bool assignSpaceImpl(ItemContainer *item) = 0;
115
116		/**
117		* Subclasses implement their releasespace logic here
118		*/
119		virtual void releaseSpaceImpl(ItemContainer *item) = 0;
120
121		/**
122		* @returns a rectangle big at least as minimumSize, trying to be as near as possible to the current item's geometry, displaced in the direction we asked, forwards or backwards
123		* @param rect the rect we want to place an item in
124		* @param minimumSize the minimum size we need to make sure is available
125		*/
126		virtual QRectF nextAvailableSpace(ItemContainer *item, const QSizeF &minimumSize, AppletsLayout::PreferredLayoutDirection direction) const = 0;
127
128		private:
129		QRectF candidateGeometry(ItemContainer *item) const;
130
131		AppletsLayout *m_layout;
132
133		// size in pixels of a crid cell
134		QSizeF m_cellSize;
135		};
136