2001-09-26 02:53:13 +04:00
|
|
|
/* -*- 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
|
2000-05-02 01:37:38 +04:00
|
|
|
*
|
2001-09-26 02:53:13 +04:00
|
|
|
* 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/
|
2000-05-02 01:37:38 +04:00
|
|
|
*
|
2001-09-26 02:53:13 +04:00
|
|
|
* 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.
|
2000-05-02 01:37:38 +04:00
|
|
|
*
|
|
|
|
* The Original Code is Mozilla Communicator client code.
|
|
|
|
*
|
2001-09-26 02:53:13 +04:00
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998-2000
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
2000-05-02 01:37:38 +04:00
|
|
|
*
|
2001-09-26 02:53:13 +04:00
|
|
|
* Contributor(s):
|
2000-07-28 14:15:28 +04:00
|
|
|
* Ryan Cassin (rcassin@supernova.org)
|
2001-09-26 02:53:13 +04:00
|
|
|
*
|
|
|
|
*
|
|
|
|
* 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 ***** */
|
2000-05-02 01:37:38 +04:00
|
|
|
|
|
|
|
#ifndef nsComposerCommands_h_
|
|
|
|
#define nsComposerCommands_h_
|
|
|
|
|
2000-05-06 03:20:21 +04:00
|
|
|
#include "nsIControllerCommand.h"
|
Landing the XPCDOM_20010329_BRANCH branch, changes mostly done by jband@netscape.com and jst@netscape.com, also some changes done by shaver@mozilla.org, peterv@netscape.com and markh@activestate.com. r= and sr= by vidur@netscape.com, jband@netscape.com, jst@netscpae.com, danm@netscape.com, hyatt@netscape.com, shaver@mozilla.org, dbradley@netscape.com, rpotts@netscape.com.
2001-05-08 21:42:36 +04:00
|
|
|
#include "nsString.h"
|
2000-05-06 03:20:21 +04:00
|
|
|
|
|
|
|
// 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 editorShell 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 editorShell, 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
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
nsBaseComposerCommand();
|
|
|
|
virtual ~nsBaseComposerCommand() {}
|
|
|
|
|
2001-04-05 03:48:03 +04:00
|
|
|
// nsISupports
|
2000-05-06 03:20:21 +04:00
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
|
2001-04-05 03:48:03 +04:00
|
|
|
// nsIControllerCommand. Declared longhand so we can make them pure virtual
|
|
|
|
NS_IMETHOD IsCommandEnabled(const nsAReadableString & aCommandName, nsISupports *aCommandRefCon, PRBool *_retval) = 0;
|
|
|
|
NS_IMETHOD DoCommand(const nsAReadableString & aCommandName, nsISupports *aCommandRefCon) = 0;
|
2000-05-06 03:20:21 +04:00
|
|
|
|
|
|
|
protected:
|
2000-05-02 01:37:38 +04:00
|
|
|
|
2000-05-06 03:20:21 +04:00
|
|
|
// utility methods to get/set the "state" attribute on the command node in the XUL
|
2001-04-05 03:48:03 +04:00
|
|
|
nsresult GetInterfaceNode(const nsAReadableString & nodeID, nsIEditorShell* editorShell, nsIDOMElement **outNode);
|
2000-05-06 03:20:21 +04:00
|
|
|
|
2001-04-05 03:48:03 +04:00
|
|
|
nsresult GetCommandNodeState(const nsAReadableString & aCommandName, nsIEditorShell* editorShell, nsString& outNodeState);
|
|
|
|
nsresult SetCommandNodeState(const nsAReadableString & aCommandName, nsIEditorShell* editorShell, const nsString& inNodeState);
|
2000-05-06 03:20:21 +04:00
|
|
|
|
2001-05-18 10:42:37 +04:00
|
|
|
// are we in HTML edit mode (not source view or plain text editing)
|
|
|
|
PRBool EditingHTML(nsIEditorShell* inEditorShell);
|
2000-05-06 03:20:21 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#define NS_DECL_COMPOSER_COMMAND(_cmd) \
|
|
|
|
class _cmd : public nsBaseComposerCommand \
|
|
|
|
{ \
|
|
|
|
public: \
|
|
|
|
NS_DECL_NSICONTROLLERCOMMAND \
|
|
|
|
};
|
2000-05-02 01:37:38 +04:00
|
|
|
|
fixes:
14753, 29843, 39864, 40141,
40139, 36679, 39542, 34729,
34855, 37216, 39292, 26447
r=sfraser,cmanske,fm; a=beppe
2000-05-25 03:00:24 +04:00
|
|
|
// virtual base class for commands that need to save and update Boolean state (like styles etc)
|
2000-05-06 03:20:21 +04:00
|
|
|
class nsBaseStateUpdatingCommand : public nsBaseComposerCommand,
|
2000-05-02 01:37:38 +04:00
|
|
|
public nsIStateUpdatingControllerCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
nsBaseStateUpdatingCommand(const char* aTagName);
|
|
|
|
virtual ~nsBaseStateUpdatingCommand();
|
|
|
|
|
|
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
|
|
|
|
|
|
NS_DECL_NSICONTROLLERCOMMAND
|
|
|
|
NS_DECL_NSISTATEUPDATINGCONTROLLERCOMMAND
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
// get the current state (on or off) for this style or block format
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, const char* aTagName, PRBool& outStateSet) = 0;
|
|
|
|
|
|
|
|
// add/remove the style
|
|
|
|
virtual nsresult ToggleState(nsIEditorShell *aEditorShell, const char* aTagName) = 0;
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
const char* mTagName;
|
|
|
|
|
2000-05-06 03:20:21 +04:00
|
|
|
PRPackedBool mGotState; // do we know the state yet?
|
|
|
|
PRPackedBool mState; // is this style "on" ?
|
2000-05-02 01:37:38 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
|
fixes:
14753, 29843, 39864, 40141,
40139, 36679, 39542, 34729,
34855, 37216, 39292, 26447
r=sfraser,cmanske,fm; a=beppe
2000-05-25 03:00:24 +04:00
|
|
|
// Shared class for the various style updating commands like bold, italics etc.
|
|
|
|
// Suitable for commands whose state is either 'on' or 'off'.
|
2000-05-02 01:37:38 +04:00
|
|
|
class nsStyleUpdatingCommand : public nsBaseStateUpdatingCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
nsStyleUpdatingCommand(const char* aTagName);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
// get the current state (on or off) for this style or block format
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, const char* aTagName, PRBool& outStateSet);
|
|
|
|
|
|
|
|
// add/remove the style
|
|
|
|
virtual nsresult ToggleState(nsIEditorShell *aEditorShell, const char* aTagName);
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
class nsListCommand : public nsBaseStateUpdatingCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
nsListCommand(const char* aTagName);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
// get the current state (on or off) for this style or block format
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, const char* aTagName, PRBool& outStateSet);
|
|
|
|
|
|
|
|
// add/remove the style
|
|
|
|
virtual nsresult ToggleState(nsIEditorShell *aEditorShell, const char* aTagName);
|
|
|
|
};
|
|
|
|
|
2000-06-06 00:26:40 +04:00
|
|
|
class nsListItemCommand : public nsBaseStateUpdatingCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
nsListItemCommand(const char* aTagName);
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
// get the current state (on or off) for this style or block format
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, const char* aTagName, PRBool& outStateSet);
|
|
|
|
|
|
|
|
// add/remove the style
|
|
|
|
virtual nsresult ToggleState(nsIEditorShell *aEditorShell, const char* aTagName);
|
|
|
|
};
|
2000-05-02 01:37:38 +04:00
|
|
|
|
fixes:
14753, 29843, 39864, 40141,
40139, 36679, 39542, 34729,
34855, 37216, 39292, 26447
r=sfraser,cmanske,fm; a=beppe
2000-05-25 03:00:24 +04:00
|
|
|
// Base class for commands whose state consists of a string (e.g. para format)
|
|
|
|
class nsMultiStateCommand : public nsBaseComposerCommand,
|
|
|
|
public nsIStateUpdatingControllerCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
|
|
|
|
nsMultiStateCommand();
|
|
|
|
virtual ~nsMultiStateCommand();
|
|
|
|
|
|
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
|
|
NS_DECL_NSICONTROLLERCOMMAND
|
|
|
|
NS_DECL_NSISTATEUPDATINGCONTROLLERCOMMAND
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, nsString& outStateString, PRBool& outMixed) = 0;
|
|
|
|
virtual nsresult SetState(nsIEditorShell *aEditorShell, nsString& newState) = 0;
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
PRPackedBool mGotState;
|
|
|
|
nsString mStateString;
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
class nsParagraphStateCommand : public nsMultiStateCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
nsParagraphStateCommand();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, nsString& outStateString, PRBool& outMixed);
|
|
|
|
virtual nsresult SetState(nsIEditorShell *aEditorShell, nsString& newState);
|
|
|
|
};
|
|
|
|
|
|
|
|
class nsFontFaceStateCommand : public nsMultiStateCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
nsFontFaceStateCommand();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, nsString& outStateString, PRBool& outMixed);
|
|
|
|
virtual nsresult SetState(nsIEditorShell *aEditorShell, nsString& newState);
|
|
|
|
};
|
|
|
|
|
Fixed lots of nsbeta3+ bugs: 45756, 47654, 41810,47503,48990, 48995,40204, 42740, 46953, 47646, 47696, 48693, 45899. r=sfraser,jfrancis
2000-08-23 04:29:24 +04:00
|
|
|
class nsFontColorStateCommand : public nsMultiStateCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
nsFontColorStateCommand();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, nsString& outStateString, PRBool& outMixed);
|
|
|
|
virtual nsresult SetState(nsIEditorShell *aEditorShell, nsString& newState);
|
|
|
|
};
|
|
|
|
|
2000-08-24 05:20:29 +04:00
|
|
|
class nsAlignCommand : public nsMultiStateCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
nsAlignCommand();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, nsString& outStateString, PRBool& outMixed);
|
|
|
|
virtual nsresult SetState(nsIEditorShell *aEditorShell, nsString& newState);
|
|
|
|
};
|
|
|
|
|
Fixed lots of nsbeta3+ bugs: 45756, 47654, 41810,47503,48990, 48995,40204, 42740, 46953, 47646, 47696, 48693, 45899. r=sfraser,jfrancis
2000-08-23 04:29:24 +04:00
|
|
|
class nsBackgroundColorStateCommand : public nsMultiStateCommand
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
nsBackgroundColorStateCommand();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
virtual nsresult GetCurrentState(nsIEditorShell *aEditorShell, nsString& outStateString, PRBool& outMixed);
|
|
|
|
virtual nsresult SetState(nsIEditorShell *aEditorShell, nsString& newState);
|
|
|
|
};
|
fixes:
14753, 29843, 39864, 40141,
40139, 36679, 39542, 34729,
34855, 37216, 39292, 26447
r=sfraser,cmanske,fm; a=beppe
2000-05-25 03:00:24 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
2000-05-02 01:37:38 +04:00
|
|
|
// composer commands
|
|
|
|
|
2000-05-06 03:20:21 +04:00
|
|
|
NS_DECL_COMPOSER_COMMAND(nsCloseCommand)
|
|
|
|
NS_DECL_COMPOSER_COMMAND(nsPrintingCommands)
|
2000-05-02 01:37:38 +04:00
|
|
|
|
|
|
|
// Generic commands
|
|
|
|
|
|
|
|
|
|
|
|
// File menu
|
2000-05-06 03:20:21 +04:00
|
|
|
NS_DECL_COMPOSER_COMMAND(nsNewCommands) // handles 'new' anything
|
2000-05-02 01:37:38 +04:00
|
|
|
|
|
|
|
|
|
|
|
// Edit menu
|
2000-05-06 03:20:21 +04:00
|
|
|
NS_DECL_COMPOSER_COMMAND(nsPasteQuotationCommand)
|
2000-05-02 01:37:38 +04:00
|
|
|
|
|
|
|
// Block transformations
|
2000-05-06 03:20:21 +04:00
|
|
|
NS_DECL_COMPOSER_COMMAND(nsIndentCommand)
|
|
|
|
NS_DECL_COMPOSER_COMMAND(nsOutdentCommand)
|
|
|
|
|
2000-06-16 18:21:46 +04:00
|
|
|
NS_DECL_COMPOSER_COMMAND(nsRemoveListCommand)
|
2000-05-06 03:20:21 +04:00
|
|
|
NS_DECL_COMPOSER_COMMAND(nsRemoveStylesCommand)
|
|
|
|
NS_DECL_COMPOSER_COMMAND(nsIncreaseFontSizeCommand)
|
|
|
|
NS_DECL_COMPOSER_COMMAND(nsDecreaseFontSizeCommand)
|
2000-05-02 01:37:38 +04:00
|
|
|
|
|
|
|
|
|
|
|
#endif // nsComposerCommands_h_
|