ISdEditable.cs


0:	// ISdEditable.cs
1:	// Copyright (C) 2001 Mike Krueger
2:	//
3:	// This program is free software; you can redistribute it and/or modify
4:	// it under the terms of the GNU General Public License as published by
5:	// the Free Software Foundation; either version 2 of the License, or
6:	// (at your option) any later version.
7:	//
8:	// This program is distributed in the hope that it will be useful,
9:	// but WITHOUT ANY WARRANTY; without even the implied warranty of
10:	// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11:	// GNU General Public License for more details.
12:	//
13:	// You should have received a copy of the GNU General Public License
14:	// along with this program; if not, write to the Free Software
15:	// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16:
17:	using System;
18:	using SharpDevelop.Internal.Undo;
19:	using System.Drawing.Printing;
20:
21:	namespace SharpDevelop.Gui.Edit {
22:
23:	public delegate void ProgressEventHandler(object sender, int percent);
24:
25:	/// <summary>
26:	/// All ContentWindow Content classes which can be load
27:	/// or saved must implement this interface.
28:	/// </summary>
29:	public interface ISdEditable
30:	{
31:
32:	/// <summary>
33:	/// Occurs when the content has changed
34:	/// </summary>
35:	event EventHandler Changed;
36:
37:	/// <summary>
38:	/// Occurs at a load/save transaction start
39:	/// </summary>
40:	event EventHandler FileTransaction;
41:
42:	/// <summary>
43:	/// Occurs while a load/save action progresses.
44:	/// </summary>
45:	event ProgressEventHandler FileTransactionProgress;
46:
47:	/// <summary>
48:	/// Occurs when a load/save transaction completed.
49:	/// </summary>
50:	event EventHandler FileTransactionComplete;
51:
52:	/// <summary>
53:	/// This method loads the content from filename
54:	/// </summary>
55:	void LoadFile(string filename);
56:
57:	/// <summary>
58:	/// This method saves the content to filename
59:	/// </summary>
60:	void SaveFile(string filename);
61:
62:	/// <returns>
63:	/// A PrintDocument class, which is used for printing;
64:	/// </returns>
65:	PrintDocument PrintDocument {
66:	get;
67:	}
68:
69:	/// <returns>
70:	/// An handler, which can handle cut, copy, paste and delete actions.
71:	/// </returns>
72:	ISdClipboardHandable ClipboardHandler {
73:	get;
74:	}
75:
76:	/// <returns>
77:	/// An undostack, which can undo and redo edit operations.
78:	/// </returns>
79:	UndoStack UndoStack {
80:	get;
81:	}
82:
83:	/// <returns>
84:	/// true, when the content can't be written;
85:	/// </returns>
86:	bool WriteProtected {
87:	get;
88:	set;
89:	}
90:	}
91:	}