diff options
author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
---|---|---|
committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
commit | 5f8de423f190bbb79a62f804151bc24824fa32d8 (patch) | |
tree | 10027f336435511475e392454359edea8e25895d /editor/composer/nsComposerCommands.h | |
parent | 49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff) | |
download | UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip |
Add m-esr52 at 52.6.0
Diffstat (limited to 'editor/composer/nsComposerCommands.h')
-rw-r--r-- | editor/composer/nsComposerCommands.h | 281 |
1 files changed, 281 insertions, 0 deletions
diff --git a/editor/composer/nsComposerCommands.h b/editor/composer/nsComposerCommands.h new file mode 100644 index 000000000..3d3855d40 --- /dev/null +++ b/editor/composer/nsComposerCommands.h @@ -0,0 +1,281 @@ +/* -*- 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 nsComposerCommands_h_ +#define nsComposerCommands_h_ + +#include "nsIControllerCommand.h" +#include "nsISupportsImpl.h" // for NS_DECL_ISUPPORTS_INHERITED, etc +#include "nscore.h" // for nsresult, NS_IMETHOD + +class nsIAtom; +class nsICommandParams; +class nsIEditor; +class nsISupports; +class nsString; + +// This is a virtual base class for commands registered with the composer controller. +// Note that such commands are instantiated once per composer, so can store state. +// Also note that IsCommandEnabled can be called with an editor that may not +// have an editor yet (because the document is loading). Most commands will want +// to return false in this case. +// Don't hold on to any references to the editor or document from +// your command. This will cause leaks. Also, be aware that the document the +// editor is editing can change under you (if the user Reverts the file, for +// instance). +class nsBaseComposerCommand : public nsIControllerCommand +{ +protected: + virtual ~nsBaseComposerCommand() {} + +public: + + nsBaseComposerCommand(); + + // nsISupports + NS_DECL_ISUPPORTS + + // nsIControllerCommand. Declared longhand so we can make them pure virtual + NS_IMETHOD IsCommandEnabled(const char * aCommandName, nsISupports *aCommandRefCon, bool *_retval) override = 0; + NS_IMETHOD DoCommand(const char * aCommandName, nsISupports *aCommandRefCon) override = 0; + +}; + + +#define NS_DECL_COMPOSER_COMMAND(_cmd) \ +class _cmd : public nsBaseComposerCommand \ +{ \ +public: \ + NS_DECL_NSICONTROLLERCOMMAND \ +}; + +// virtual base class for commands that need to save and update Boolean state (like styles etc) +class nsBaseStateUpdatingCommand : public nsBaseComposerCommand +{ +public: + explicit nsBaseStateUpdatingCommand(nsIAtom* aTagName); + + NS_DECL_ISUPPORTS_INHERITED + + NS_DECL_NSICONTROLLERCOMMAND + +protected: + virtual ~nsBaseStateUpdatingCommand(); + + // get the current state (on or off) for this style or block format + virtual nsresult GetCurrentState(nsIEditor* aEditor, nsICommandParams* aParams) = 0; + + // add/remove the style + virtual nsresult ToggleState(nsIEditor* aEditor) = 0; + +protected: + nsIAtom* mTagName; +}; + + +// Shared class for the various style updating commands like bold, italics etc. +// Suitable for commands whose state is either 'on' or 'off'. +class nsStyleUpdatingCommand : public nsBaseStateUpdatingCommand +{ +public: + explicit nsStyleUpdatingCommand(nsIAtom* aTagName); + +protected: + + // get the current state (on or off) for this style or block format + virtual nsresult GetCurrentState(nsIEditor* aEditor, nsICommandParams* aParams); + + // add/remove the style + virtual nsresult ToggleState(nsIEditor* aEditor); +}; + + +class nsInsertTagCommand : public nsBaseComposerCommand +{ +public: + explicit nsInsertTagCommand(nsIAtom* aTagName); + + NS_DECL_ISUPPORTS_INHERITED + + NS_DECL_NSICONTROLLERCOMMAND + +protected: + virtual ~nsInsertTagCommand(); + + nsIAtom* mTagName; +}; + + +class nsListCommand : public nsBaseStateUpdatingCommand +{ +public: + explicit nsListCommand(nsIAtom* aTagName); + +protected: + + // get the current state (on or off) for this style or block format + virtual nsresult GetCurrentState(nsIEditor* aEditor, nsICommandParams* aParams); + + // add/remove the style + virtual nsresult ToggleState(nsIEditor* aEditor); +}; + +class nsListItemCommand : public nsBaseStateUpdatingCommand +{ +public: + explicit nsListItemCommand(nsIAtom* aTagName); + +protected: + + // get the current state (on or off) for this style or block format + virtual nsresult GetCurrentState(nsIEditor* aEditor, nsICommandParams* aParams); + + // add/remove the style + virtual nsresult ToggleState(nsIEditor* aEditor); +}; + +// Base class for commands whose state consists of a string (e.g. para format) +class nsMultiStateCommand : public nsBaseComposerCommand +{ +public: + + nsMultiStateCommand(); + + NS_DECL_ISUPPORTS_INHERITED + NS_DECL_NSICONTROLLERCOMMAND + +protected: + virtual ~nsMultiStateCommand(); + + virtual nsresult GetCurrentState(nsIEditor *aEditor, nsICommandParams* aParams) =0; + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState) = 0; + +}; + + +class nsParagraphStateCommand : public nsMultiStateCommand +{ +public: + nsParagraphStateCommand(); + +protected: + + virtual nsresult GetCurrentState(nsIEditor *aEditor, nsICommandParams* aParams); + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState); +}; + +class nsFontFaceStateCommand : public nsMultiStateCommand +{ +public: + nsFontFaceStateCommand(); + +protected: + + virtual nsresult GetCurrentState(nsIEditor *aEditor, nsICommandParams* aParams); + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState); +}; + +class nsFontSizeStateCommand : public nsMultiStateCommand +{ +public: + nsFontSizeStateCommand(); + +protected: + + virtual nsresult GetCurrentState(nsIEditor *aEditor, + nsICommandParams* aParams); + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState); +}; + +class nsHighlightColorStateCommand : public nsMultiStateCommand +{ +public: + nsHighlightColorStateCommand(); + +protected: + + NS_IMETHOD IsCommandEnabled(const char *aCommandName, nsISupports *aCommandRefCon, bool *_retval); + virtual nsresult GetCurrentState(nsIEditor *aEditor, nsICommandParams* aParams); + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState); + +}; + +class nsFontColorStateCommand : public nsMultiStateCommand +{ +public: + nsFontColorStateCommand(); + +protected: + + virtual nsresult GetCurrentState(nsIEditor *aEditor, nsICommandParams* aParams); + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState); +}; + +class nsAlignCommand : public nsMultiStateCommand +{ +public: + nsAlignCommand(); + +protected: + + virtual nsresult GetCurrentState(nsIEditor *aEditor, nsICommandParams* aParams); + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState); +}; + +class nsBackgroundColorStateCommand : public nsMultiStateCommand +{ +public: + nsBackgroundColorStateCommand(); + +protected: + + virtual nsresult GetCurrentState(nsIEditor *aEditor, nsICommandParams* aParams); + virtual nsresult SetState(nsIEditor *aEditor, nsString& newState); +}; + +class nsAbsolutePositioningCommand : public nsBaseStateUpdatingCommand +{ +public: + nsAbsolutePositioningCommand(); + +protected: + + NS_IMETHOD IsCommandEnabled(const char *aCommandName, nsISupports *aCommandRefCon, bool *_retval); + virtual nsresult GetCurrentState(nsIEditor* aEditor, nsICommandParams* aParams); + virtual nsresult ToggleState(nsIEditor* aEditor); +}; + +// composer commands + +NS_DECL_COMPOSER_COMMAND(nsCloseCommand) +NS_DECL_COMPOSER_COMMAND(nsDocumentStateCommand) +NS_DECL_COMPOSER_COMMAND(nsSetDocumentStateCommand) +NS_DECL_COMPOSER_COMMAND(nsSetDocumentOptionsCommand) +//NS_DECL_COMPOSER_COMMAND(nsPrintingCommands) + +NS_DECL_COMPOSER_COMMAND(nsDecreaseZIndexCommand) +NS_DECL_COMPOSER_COMMAND(nsIncreaseZIndexCommand) + +// Generic commands + +// File menu +NS_DECL_COMPOSER_COMMAND(nsNewCommands) // handles 'new' anything + +// Edit menu +NS_DECL_COMPOSER_COMMAND(nsPasteNoFormattingCommand) + +// Block transformations +NS_DECL_COMPOSER_COMMAND(nsIndentCommand) +NS_DECL_COMPOSER_COMMAND(nsOutdentCommand) + +NS_DECL_COMPOSER_COMMAND(nsRemoveListCommand) +NS_DECL_COMPOSER_COMMAND(nsRemoveStylesCommand) +NS_DECL_COMPOSER_COMMAND(nsIncreaseFontSizeCommand) +NS_DECL_COMPOSER_COMMAND(nsDecreaseFontSizeCommand) + +// Insert content commands +NS_DECL_COMPOSER_COMMAND(nsInsertHTMLCommand) + +#endif // nsComposerCommands_h_ |