greenshot/GreenshotCore/Interfaces/Forms/IImageEditor.cs
2010-07-25 18:20:18 +00:00

74 lines
2.5 KiB
C#

/*
* Greenshot - a free and open source screenshot tool
* Copyright (C) 2007-2010 Thomas Braun, Jens Klingen, Robin Krom
*
* For more information see: http://getgreenshot.org/
* The Greenshot project is hosted on Sourceforge: http://sourceforge.net/projects/greenshot/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
using System;
using System.Drawing;
using System.IO;
using System.Windows.Forms;
using Greenshot.Capturing;
using Greenshot.Drawing;
namespace Greenshot.Forms {
/// <summary>
/// The IImageEditor is the Interface that the Greenshot ImageEditor has to implement
/// </summary>
public interface IImageEditor {
/// <summary>
/// Return the IWin32Window, this way Plugins have access to the HWND handles wich can be used with Win32 API calls.
/// </summary>
IWin32Window WindowHandle {
get;
}
/// <summary>
/// Get the current Image from the Editor for Exporting (save/upload etc)
/// This is actually a wrapper which calls Surface.GetImageForExport().
/// Don't forget to call image.Dispose() when finished!!!
/// </summary>
/// <returns>Bitmap</returns>
Image GetImageForExport();
/// <summary>
/// Will save the current Image in the supplied format to the given stream
/// </summary>
/// <param name="stream">The stream the image is stored on</param>
/// <param name="extension">The image type (extension), e.g. "png", "jpg", "bmp"</param>
/// <param name="quality">Only needed for "jpg"</param>
void SaveToStream(Stream stream, string extension, int quality);
/// <summary>
/// Get the ToolStripMenuItem where plugins can place their Menu entrys
/// </summary>
/// <returns>ToolStripMenuItem</returns>
ToolStripMenuItem GetPluginMenuItem();
/// <summary>
/// Make the ICaptureDetails from the current Surface in the EditorForm available.
/// </summary>
ICaptureDetails CaptureDetails {
get;
}
ISurface Surface {
get;
}
}
}