mattercontrol/Library/Interfaces/ILibraryContainer.cs

/*
Copyright (c) 2017, John Lewin
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using MatterHackers.Agg.Image;

namespace MatterHackers.MatterControl.Library
{
	public interface ILibraryContainer : IDisposable
	{
		string ID { get; }
		string Name { get; }
		string StatusMessage { get; }
		string KeywordFilter { get; set; }
		bool IsProtected { get; }

		Type DefaultView { get; }

		event EventHandler ContentChanged;

		List<ILibraryContainerLink> ChildContainers { get; }
		List<ILibraryItem> Items { get; }

		ILibraryContainer Parent { get; set; }

		Task<ImageBuffer> GetThumbnail(ILibraryItem item, int width, int height);

		void Deactivate();
		void Activate();
		void Load();
	}

	public interface ILibraryWritableContainer : ILibraryContainer
	{
		event EventHandler<ItemChangedEventArgs> ItemContentChanged;

		void Add(IEnumerable<ILibraryItem> items);
		void Remove(IEnumerable<ILibraryItem> items);
		void Rename(ILibraryItem item, string revisedName);
		void Move(IEnumerable<ILibraryItem> items, ILibraryContainer targetContainer);

		void SetThumbnail(ILibraryItem item, int width, int height, ImageBuffer imageBuffer);
		bool AllowAction(ContainerActions containerActions);
	}

	public enum ContainerActions
	{
		AddItems,
		AddContainers,
		RenameItems,
		RemoveItems
	}

	public class ItemChangedEventArgs : EventArgs
	{
		public ILibraryItem LibraryItem { get; }

		public ItemChangedEventArgs(ILibraryItem libraryItem)
		{
			this.LibraryItem = libraryItem;
		}
	}
}