gecko-dev/content/base/public/nsIDiskDocument.idl

84 lines
3.8 KiB
Plaintext

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Netscape Public License
* Version 1.1 (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.mozilla.org/NPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Original Author: Simon Fraser (sfraser@netscape.com)
*
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the NPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the NPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
#include "nsISupports.idl"
#include "nsIURI.idl"
// {dd038282-d5a2-11d4-aedb-e1c4b1c8b9fc}
[scriptable, uuid(dd038282-d5a2-11d4-aedb-e1c4b1c8b9fc)]
interface nsIDiskDocument : nsISupports
{
/** The modification count for the document. A +ve mod count indicates
* that the document is dirty, and needs saving.
*/
readonly attribute long modificationCount;
/** Save the file to disk. This will be called after the caller has
* displayed a put file dialog, which the user confirmed. The internal
* fileSpec of the document is only updated with the given fileSpec if inSaveCopy == PR_FALSE.
*
* @param aURI location to which to stream the document.
* @param aReplaceExisting true if replacing an existing file, otherwise false.
* If false and aURI exists, SaveFile returns an error.
* @param aSaveCopy True to save a copy of the file, without changing the file
* referenced internally.
* @param aFileType Mime type to save (text/plain or text/html)
* @param aFileCharset Charset to save the document in. If this is an empty
* string, or "UCS2", then the doc will be saved as Unicode.
* @param aSaveFlags Flags used by the document encoder (see nsIDocumentEncoder).
* @param inWrapColumn Wrap column, assuming that flags specify wrapping.
*/
void SaveFile(in nsIURI aFile, in boolean aReplaceExisting, in boolean aSaveCopy,
in wstring aFileType, in wstring aFileCharset, in unsigned long aSaveFlags,
in unsigned long aWrapColumn);
/** Reset the modification count for the document. This marks the documents as
* 'clean' and not in need of saving.
*/
void ResetModificationCount();
/** Increment the modification count for the document by the given
* amount (which may be -ve).
*/
void IncrementModificationCount(in long aNumMods);
};