gecko-dev/editor/libeditor/nsIEditRules.h
Makoto Kato 353b47086e Bug 1360154 - Part 1. DocumentIsBody should return bool, not nsresult. r=masayuki
nsIEditRules::GetDocumentIsEmpty doesn't return error without null parameter, so we should use bool as return value instead.

MozReview-Commit-ID: HIoQmKu6ETF

--HG--
extra : rebase_source : 570452e7072d8e0e837bb2822c9c0ab9c0d1a8cf
2017-05-11 14:03:26 +09:00

69 lines
2.0 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsIEditRules_h
#define nsIEditRules_h
#define NS_IEDITRULES_IID \
{ 0x3836386d, 0x806a, 0x488d, \
{ 0x8b, 0xab, 0xaf, 0x42, 0xbb, 0x4c, 0x90, 0x66 } }
#include "mozilla/EditorBase.h" // for EditAction enum
namespace mozilla {
class TextEditor;
namespace dom {
class Selection;
} // namespace dom
/**
* Base for an object to encapsulate any additional info needed to be passed
* to rules system by the editor.
*/
class RulesInfo
{
public:
explicit RulesInfo(EditAction aAction)
: action(aAction)
{}
virtual ~RulesInfo() {}
EditAction action;
};
} // namespace mozilla
/**
* Interface of editing rules.
*/
class nsIEditRules : public nsISupports
{
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_IEDITRULES_IID)
//Interfaces for addref and release and queryinterface
//NOTE: Use NS_DECL_ISUPPORTS_INHERITED in any class inherited from nsIEditRules
NS_IMETHOD Init(mozilla::TextEditor* aTextEditor) = 0;
NS_IMETHOD SetInitialValue(const nsAString& aValue) = 0;
NS_IMETHOD DetachEditor() = 0;
NS_IMETHOD BeforeEdit(EditAction action,
nsIEditor::EDirection aDirection) = 0;
NS_IMETHOD AfterEdit(EditAction action,
nsIEditor::EDirection aDirection) = 0;
NS_IMETHOD WillDoAction(mozilla::dom::Selection* aSelection,
mozilla::RulesInfo* aInfo, bool* aCancel,
bool* aHandled) = 0;
NS_IMETHOD DidDoAction(mozilla::dom::Selection* aSelection,
mozilla::RulesInfo* aInfo, nsresult aResult) = 0;
NS_IMETHOD_(bool) DocumentIsEmpty() = 0;
NS_IMETHOD DocumentModified() = 0;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsIEditRules, NS_IEDITRULES_IID)
#endif // #ifndef nsIEditRules_h