Back to index

lightning-sunbird  0.9+nobinonly
nsEditorCommands.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator client code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsIEditorCommand_h_
00039 #define nsIEditorCommand_h_
00040 
00041 #include "nsCOMPtr.h"
00042 #include "nsIControllerCommand.h"
00043 #include "nsIAtom.h"
00044 
00045 // This is a virtual base class for commands registered with the editor controller.
00046 // Note that such commands can be shared by more than on editor instance, so
00047 // MUST be stateless. Any state must be stored via the refCon (an nsIEditor).
00048 class nsBaseEditorCommand : public nsIControllerCommand
00049 {
00050 public:
00051 
00052               nsBaseEditorCommand();
00053   virtual     ~nsBaseEditorCommand() {}
00054     
00055   NS_DECL_ISUPPORTS
00056     
00057   NS_IMETHOD  IsCommandEnabled(const char * aCommandName, nsISupports *aCommandRefCon, PRBool *_retval) = 0;
00058   NS_IMETHOD  DoCommand(const char *aCommandName, nsISupports *aCommandRefCon) = 0;
00059   
00060 };
00061 
00062 
00063 #define NS_DECL_EDITOR_COMMAND(_cmd)                    \
00064 class _cmd : public nsBaseEditorCommand                 \
00065 {                                                       \
00066 public:                                                 \
00067   NS_IMETHOD IsCommandEnabled(const char * aCommandName, nsISupports *aCommandRefCon, PRBool *_retval); \
00068   NS_IMETHOD DoCommand(const char *aCommandName, nsISupports *aCommandRefCon); \
00069   NS_IMETHOD DoCommandParams(const char *aCommandName,nsICommandParams *aParams, nsISupports *aCommandRefCon); \
00070   NS_IMETHOD GetCommandStateParams(const char *aCommandName,nsICommandParams *aParams, nsISupports *aCommandRefCon); \
00071 };
00072 
00073 
00074 
00075 // basic editor commands
00076 NS_DECL_EDITOR_COMMAND(nsUndoCommand)
00077 NS_DECL_EDITOR_COMMAND(nsRedoCommand)
00078 NS_DECL_EDITOR_COMMAND(nsClearUndoCommand)
00079 
00080 NS_DECL_EDITOR_COMMAND(nsCutCommand)
00081 NS_DECL_EDITOR_COMMAND(nsCutOrDeleteCommand)
00082 NS_DECL_EDITOR_COMMAND(nsCopyCommand)
00083 NS_DECL_EDITOR_COMMAND(nsCopyOrDeleteCommand)
00084 NS_DECL_EDITOR_COMMAND(nsPasteCommand)
00085 NS_DECL_EDITOR_COMMAND(nsSwitchTextDirectionCommand)
00086 NS_DECL_EDITOR_COMMAND(nsDeleteCommand)
00087 NS_DECL_EDITOR_COMMAND(nsSelectAllCommand)
00088 
00089 NS_DECL_EDITOR_COMMAND(nsSelectionMoveCommands)
00090 
00091 // Insert content commands
00092 NS_DECL_EDITOR_COMMAND(nsInsertPlaintextCommand)
00093 NS_DECL_EDITOR_COMMAND(nsPasteQuotationCommand)
00094 
00095 
00096 #if 0
00097 // template for new command
00098 NS_IMETHODIMP
00099 nsFooCommand::IsCommandEnabled(const char * aCommandName, nsISupports *aCommandRefCon, PRBool *_retval)
00100 {
00101   return NS_ERROR_NOT_IMPLEMENTED;
00102 }
00103 
00104 
00105 NS_IMETHODIMP
00106 nsFooCommand::DoCommand(const char *aCommandName, const nsAString & aCommandParams, nsISupports *aCommandRefCon)
00107 {
00108   return NS_ERROR_NOT_IMPLEMENTED;
00109 }
00110 
00111 
00112 #endif
00113 
00114 #endif // nsIEditorCommand_h_