Back to index

lightning-sunbird  0.9+nobinonly
nsSwitchToUIThread.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.org 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 the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 SWITCHTOUITHREAD_H
00039 #define SWITCHTOUITHREAD_H
00040 
00041 #include "nsISupports.h"
00042 
00043 // foreward declaration
00044 struct MethodInfo;
00045 
00046 
00047 #define WM_CALLMETHOD   'CAme'
00048 
00053 class nsSwitchToUIThread {
00054 
00055 public:
00056     virtual bool CallMethod(MethodInfo *info) = 0;
00057 
00058        // Enumeration of the methods which are accessable on the "main GUI thread"
00059        // via the CallMethod(...) mechanism...
00060        // see nsSwitchToUIThread
00061        enum
00062        {
00063            CREATE       = 0x0101,
00064            CREATE_NATIVE,
00065            DESTROY,
00066            SET_FOCUS,
00067            GOT_FOCUS,
00068            KILL_FOCUS,
00069            ONMOUSE,
00070            ONDROP,
00071            ONWHEEL,
00072            ONPAINT,
00073            ONRESIZE,
00074            CLOSEWINDOW,
00075            ONKEY,
00076            BTNCLICK,
00077            ONACTIVATE,
00078            ONMOVE,
00079            ONWORKSPACE
00080 #if defined(BeIME)
00081            ,
00082               ONIME
00083 #endif
00084        };
00085 
00086 };
00087 
00088 //
00089 // Structure used for passing the information necessary for synchronously 
00090 // invoking a method on the GUI thread...
00091 //
00092 struct MethodInfo {
00093        nsISupports                 *widget;
00094     nsSwitchToUIThread      *target;
00095     uint32                         methodId;
00096     int                                   nArgs;
00097     uint32                         *args;
00098 
00099     MethodInfo(nsISupports *ref, nsSwitchToUIThread *obj, uint32 id, int numArgs = 0, uint32 *arguments = 0)
00100     {
00101               widget = ref;
00102               NS_ADDREF(ref);
00103               target   = obj;
00104               methodId = id;
00105               nArgs    = numArgs;
00106               args = new uint32 [numArgs];
00107               memcpy(args, arguments, sizeof(uint32) * numArgs);
00108     }
00109 
00110        ~MethodInfo()
00111        {
00112               delete [] args;
00113               NS_RELEASE(widget);
00114        }
00115 
00116     bool Invoke() { return target->CallMethod(this); }
00117 };
00118 
00119 #endif // TOUITHRD_H
00120