1998-04-14 00:24:54 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Netscape Public License
|
|
|
|
* Version 1.0 (the "NPL"); you may not use this file except in
|
|
|
|
* compliance with the NPL. You may obtain a copy of the NPL at
|
|
|
|
* http://www.mozilla.org/NPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* NPL.
|
|
|
|
*
|
|
|
|
* The Initial Developer of this code under the NPL is Netscape
|
|
|
|
* Communications Corporation. Portions created by Netscape are
|
|
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
|
|
|
* Reserved.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef nsIWidget_h__
|
|
|
|
#define nsIWidget_h__
|
|
|
|
|
|
|
|
#include "nsISupports.h"
|
|
|
|
#include "nsColor.h"
|
|
|
|
#include "nsIMouseListener.h"
|
1999-01-27 18:48:22 +03:00
|
|
|
#include "nsIMenuListener.h"
|
1998-04-14 00:24:54 +04:00
|
|
|
#include "nsIImage.h"
|
|
|
|
|
|
|
|
#include "prthread.h"
|
|
|
|
#include "nsGUIEvent.h"
|
|
|
|
|
1998-04-14 04:31:59 +04:00
|
|
|
// forward declarations
|
1998-07-29 22:51:45 +04:00
|
|
|
class nsIAppShell;
|
1998-04-14 04:31:59 +04:00
|
|
|
class nsIToolkit;
|
|
|
|
class nsIFontMetrics;
|
|
|
|
class nsIToolkit;
|
|
|
|
class nsIRenderingContext;
|
|
|
|
class nsIEnumerator;
|
|
|
|
class nsIDeviceContext;
|
|
|
|
struct nsRect;
|
|
|
|
struct nsFont;
|
1998-09-29 02:32:48 +04:00
|
|
|
class nsIMenuBar;
|
1999-03-12 07:30:30 +03:00
|
|
|
class nsIEventListener;
|
1998-04-14 00:24:54 +04:00
|
|
|
/**
|
1998-04-15 01:33:43 +04:00
|
|
|
* Callback function that processes events.
|
1998-04-14 00:24:54 +04:00
|
|
|
* The argument is actually a subtype (subclass) of nsEvent which carries
|
|
|
|
* platform specific information about the event. Platform specific code knows
|
|
|
|
* how to deal with it.
|
|
|
|
* The return value determines whether or not the default action should take place.
|
|
|
|
*/
|
|
|
|
|
|
|
|
typedef nsEventStatus (*PR_CALLBACK EVENT_CALLBACK)(nsGUIEvent *event);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Flags for the getNativeData function.
|
1998-04-15 01:33:43 +04:00
|
|
|
* See getNativeData()
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
|
|
|
#define NS_NATIVE_WINDOW 0
|
|
|
|
#define NS_NATIVE_GRAPHIC 1
|
|
|
|
#define NS_NATIVE_COLORMAP 2
|
1998-05-21 03:19:38 +04:00
|
|
|
#define NS_NATIVE_WIDGET 3
|
1998-06-04 09:13:36 +04:00
|
|
|
#define NS_NATIVE_DISPLAY 4
|
1998-08-27 21:31:59 +04:00
|
|
|
#define NS_NATIVE_REGION 5
|
1998-09-26 02:22:57 +04:00
|
|
|
#define NS_NATIVE_OFFSETX 6
|
|
|
|
#define NS_NATIVE_OFFSETY 7
|
1999-03-12 07:30:30 +03:00
|
|
|
#define NS_NATIVE_PLUGIN_PORT 8
|
1999-07-02 17:06:48 +04:00
|
|
|
#define NS_NATIVE_SCREEN 9
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
// {18032AD5-B265-11d1-AA2A-000000000000}
|
|
|
|
#define NS_IWIDGET_IID \
|
|
|
|
{ 0x18032ad5, 0xb265, 0x11d1, \
|
|
|
|
{ 0xaa, 0x2a, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } }
|
|
|
|
|
|
|
|
|
|
|
|
// Hide the native window systems real window type so as to avoid
|
1998-04-14 04:31:59 +04:00
|
|
|
// including native window system types and api's. This is necessary
|
|
|
|
// to ensure cross-platform code.
|
1998-06-25 08:24:45 +04:00
|
|
|
typedef void* nsNativeWidget;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1998-04-18 03:45:07 +04:00
|
|
|
/**
|
|
|
|
* Border styles
|
|
|
|
*/
|
|
|
|
|
|
|
|
enum nsBorderStyle {
|
1999-04-24 20:33:12 +04:00
|
|
|
// no border
|
1998-04-18 04:27:48 +04:00
|
|
|
eBorderStyle_none,
|
1999-04-24 20:33:12 +04:00
|
|
|
// dialog box border + title area
|
1998-11-02 19:58:55 +03:00
|
|
|
eBorderStyle_dialog,
|
1999-04-24 20:33:12 +04:00
|
|
|
// window border
|
1998-11-02 22:13:05 +03:00
|
|
|
eBorderStyle_window,
|
1999-04-24 20:33:12 +04:00
|
|
|
// child window 3D border hint
|
|
|
|
eBorderStyle_3DChildWindow,
|
|
|
|
// top level window without border (drop down in combo
|
|
|
|
// boxes, etc)
|
|
|
|
eBorderStyle_BorderlessTopLevel
|
1998-04-18 03:45:07 +04:00
|
|
|
};
|
1998-04-14 04:31:59 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Cursor types.
|
|
|
|
*/
|
|
|
|
|
1998-04-15 01:33:43 +04:00
|
|
|
enum nsCursor { ///(normal cursor, usually rendered as an arrow)
|
|
|
|
eCursor_standard,
|
|
|
|
///(system is busy, usually rendered as a hourglass or watch)
|
1998-04-14 04:31:59 +04:00
|
|
|
eCursor_wait,
|
1998-04-15 01:33:43 +04:00
|
|
|
///(Selecting something, usually rendered as an IBeam)
|
1998-04-14 04:31:59 +04:00
|
|
|
eCursor_select,
|
1998-04-15 01:33:43 +04:00
|
|
|
///(can hyper-link, usually rendered as a human hand)
|
1998-07-31 01:25:35 +04:00
|
|
|
eCursor_hyperlink,
|
|
|
|
///(west/east sizing, usually rendered as ->||<-)
|
|
|
|
eCursor_sizeWE,
|
|
|
|
///(north/south sizing, usually rendered as sizeWE rotated 90 degrees)
|
1998-08-07 19:35:27 +04:00
|
|
|
eCursor_sizeNS,
|
|
|
|
eCursor_arrow_north,
|
|
|
|
eCursor_arrow_north_plus,
|
|
|
|
eCursor_arrow_south,
|
|
|
|
eCursor_arrow_south_plus,
|
|
|
|
eCursor_arrow_west,
|
|
|
|
eCursor_arrow_west_plus,
|
|
|
|
eCursor_arrow_east,
|
1999-07-07 11:50:03 +04:00
|
|
|
eCursor_arrow_east_plus,
|
|
|
|
eCursor_crosshair,
|
|
|
|
//Don't know what 'move' cursor should be. See CSS2.
|
|
|
|
eCursor_move,
|
|
|
|
eCursor_help
|
1998-08-07 19:35:27 +04:00
|
|
|
};
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1998-05-15 01:34:08 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Basic struct for widget initialization data.
|
|
|
|
* @see Create member function of nsIWidget
|
|
|
|
*/
|
|
|
|
|
1998-08-20 03:11:41 +04:00
|
|
|
struct nsWidgetInitData {
|
1998-10-22 00:10:22 +04:00
|
|
|
nsWidgetInitData()
|
1999-01-28 20:06:39 +03:00
|
|
|
: clipChildren(PR_FALSE), clipSiblings(PR_FALSE),
|
1998-11-02 19:58:55 +03:00
|
|
|
mBorderStyle(eBorderStyle_window)
|
1998-10-22 00:10:22 +04:00
|
|
|
{
|
|
|
|
}
|
|
|
|
|
1999-01-28 20:06:39 +03:00
|
|
|
// when painting exclude area occupied by child windows and sibling windows
|
|
|
|
PRPackedBool clipChildren, clipSiblings;
|
1998-11-02 19:58:55 +03:00
|
|
|
nsBorderStyle mBorderStyle;
|
1998-08-20 03:11:41 +04:00
|
|
|
};
|
1998-05-15 01:34:08 +04:00
|
|
|
|
1998-04-15 00:48:14 +04:00
|
|
|
/**
|
1998-04-23 20:51:25 +04:00
|
|
|
* The base class for all the widgets. It provides the interface for
|
|
|
|
* all basic and necessary functionality.
|
1998-04-15 00:48:14 +04:00
|
|
|
*/
|
1998-04-14 00:24:54 +04:00
|
|
|
class nsIWidget : public nsISupports {
|
|
|
|
|
1998-04-14 04:31:59 +04:00
|
|
|
public:
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1999-03-03 22:48:57 +03:00
|
|
|
static const nsIID& GetIID() { static nsIID iid = NS_IWIDGET_IID; return iid; }
|
1998-12-18 01:13:41 +03:00
|
|
|
|
1998-04-14 00:24:54 +04:00
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Create and initialize a widget.
|
|
|
|
*
|
|
|
|
* The widget represents a window that can be drawn into. It also is the
|
|
|
|
* base class for user-interface widgets such as buttons and text boxes.
|
|
|
|
*
|
1998-04-23 20:51:25 +04:00
|
|
|
* All the arguments can be NULL in which case a top level window
|
|
|
|
* with size 0 is created. The event callback function has to be
|
|
|
|
* provided only if the caller wants to deal with the events this
|
|
|
|
* widget receives. The event callback is basically a preprocess
|
|
|
|
* hook called synchronously. The return value determines whether
|
|
|
|
* the event goes to the default window procedure or it is hidden
|
|
|
|
* to the os. The assumption is that if the event handler returns
|
1998-05-05 23:58:27 +04:00
|
|
|
* false the widget does not see the event. The widget should not
|
|
|
|
* automatically clear the window to the background color. The
|
|
|
|
* calling code must handle paint messages and clear the background
|
|
|
|
* itself.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-05-05 23:58:27 +04:00
|
|
|
* @param parent or null if it's a top level window
|
1998-04-14 04:31:59 +04:00
|
|
|
* @param aRect the widget dimension
|
|
|
|
* @param aHandleEventFunction the event handler callback function
|
1998-07-29 22:51:45 +04:00
|
|
|
* @param aContext
|
|
|
|
* @param aAppShell the parent application shell. If nsnull,
|
|
|
|
* the parent window's application shell will be used.
|
|
|
|
* @param aToolkit
|
1998-05-05 23:58:27 +04:00
|
|
|
* @param aInitData data that is used for widget initialization
|
1998-04-25 01:37:30 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Create(nsIWidget *aParent,
|
1998-04-15 00:48:14 +04:00
|
|
|
const nsRect &aRect,
|
|
|
|
EVENT_CALLBACK aHandleEventFunction,
|
1998-04-14 00:24:54 +04:00
|
|
|
nsIDeviceContext *aContext,
|
1998-07-29 22:51:45 +04:00
|
|
|
nsIAppShell *aAppShell = nsnull,
|
1998-04-25 01:37:30 +04:00
|
|
|
nsIToolkit *aToolkit = nsnull,
|
1998-05-15 01:34:08 +04:00
|
|
|
nsWidgetInitData *aInitData = nsnull) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Create and initialize a widget with a native window parent
|
|
|
|
*
|
|
|
|
* The widget represents a window that can be drawn into. It also is the
|
|
|
|
* base class for user-interface widgets such as buttons and text boxes.
|
|
|
|
*
|
1998-04-23 20:51:25 +04:00
|
|
|
* All the arguments can be NULL in which case a top level window
|
|
|
|
* with size 0 is created. The event callback function has to be
|
|
|
|
* provided only if the caller wants to deal with the events this
|
|
|
|
* widget receives. The event callback is basically a preprocess
|
|
|
|
* hook called synchronously. The return value determines whether
|
|
|
|
* the event goes to the default window procedure or it is hidden
|
|
|
|
* to the os. The assumption is that if the event handler returns
|
|
|
|
* false the widget does not see the event.
|
1998-04-14 04:31:59 +04:00
|
|
|
*
|
|
|
|
* @param aParent native window.
|
|
|
|
* @param aRect the widget dimension
|
|
|
|
* @param aHandleEventFunction the event handler callback function
|
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Create(nsNativeWidget aParent,
|
1998-07-29 22:51:45 +04:00
|
|
|
const nsRect &aRect,
|
|
|
|
EVENT_CALLBACK aHandleEventFunction,
|
1998-04-14 00:24:54 +04:00
|
|
|
nsIDeviceContext *aContext,
|
1998-07-29 22:51:45 +04:00
|
|
|
nsIAppShell *aAppShell = nsnull,
|
|
|
|
nsIToolkit *aToolkit = nsnull,
|
1998-05-15 01:34:08 +04:00
|
|
|
nsWidgetInitData *aInitData = nsnull) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1998-08-07 09:19:40 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Accessor functions to get and set the client data associated with the
|
|
|
|
* widget.
|
|
|
|
*/
|
|
|
|
//@{
|
|
|
|
NS_IMETHOD GetClientData(void*& aClientData) = 0;
|
|
|
|
NS_IMETHOD SetClientData(void* aClientData) = 0;
|
|
|
|
//@}
|
|
|
|
|
1998-04-14 00:24:54 +04:00
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Close and destroy the internal native window.
|
|
|
|
* This method does not delete the widget.
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Destroy(void) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Return the parent Widget of this Widget or nsnull if this is a
|
|
|
|
* top level window
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @return the parent widget or nsnull if it does not have a parent
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
*/
|
1998-04-14 00:24:54 +04:00
|
|
|
virtual nsIWidget* GetParent(void) = 0;
|
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Return an nsEnumerator over the children of this widget.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @return an enumerator over the list of children or nsnull if it does not
|
|
|
|
* have any children
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
*/
|
1998-04-14 00:24:54 +04:00
|
|
|
virtual nsIEnumerator* GetChildren(void) = 0;
|
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Show or hide this widget
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
* @param aState PR_TRUE to show the Widget, PR_FALSE to hide it
|
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Show(PRBool aState) = 0;
|
|
|
|
|
1999-06-14 00:56:08 +04:00
|
|
|
/**
|
|
|
|
* Make the window modal
|
|
|
|
*
|
|
|
|
*
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD SetModal(void) = 0;
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
/**
|
|
|
|
* Returns whether the window is visible
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD IsVisible(PRBool & aState) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Move this widget.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @param aX the new x position expressed in the parent's coordinate system
|
|
|
|
* @param aY the new y position expressed in the parent's coordinate system
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
**/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Move(PRUint32 aX, PRUint32 aY) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Resize this widget.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @param aWidth the new width expressed in the parent's coordinate system
|
|
|
|
* @param aHeight the new height expressed in the parent's coordinate system
|
1998-06-02 00:26:50 +04:00
|
|
|
* @param aRepaint whether the widget should be repainted
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Resize(PRUint32 aWidth,
|
1998-06-02 00:26:50 +04:00
|
|
|
PRUint32 aHeight,
|
|
|
|
PRBool aRepaint) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Move or resize this widget.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-06-02 00:26:50 +04:00
|
|
|
* @param aX the new x position expressed in the parent's coordinate system
|
|
|
|
* @param aY the new y position expressed in the parent's coordinate system
|
|
|
|
* @param aWidth the new width expressed in the parent's coordinate system
|
|
|
|
* @param aHeight the new height expressed in the parent's coordinate system
|
|
|
|
* @param aRepaint whether the widget should be repainted if the size changes
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Resize(PRUint32 aX,
|
1998-04-14 00:24:54 +04:00
|
|
|
PRUint32 aY,
|
|
|
|
PRUint32 aWidth,
|
1998-06-02 00:26:50 +04:00
|
|
|
PRUint32 aHeight,
|
|
|
|
PRBool aRepaint) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Enable or disable this Widget
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @param aState PR_TRUE to enable the Widget, PR_FALSE to disable it.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Enable(PRBool aState) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Give focus to this widget.
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetFocus(void) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-11-05 00:43:47 +03:00
|
|
|
* Get this widget's dimension outside dimensions, or in otherswords
|
|
|
|
* the dimensions of the widget or window
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @param aRect on return it holds the x. y, width and height of this widget
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD GetBounds(nsRect &aRect) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1998-11-05 00:43:47 +03:00
|
|
|
/**
|
|
|
|
* Get this widget's client area dimensions, if the window has a 3D border appearance
|
|
|
|
* this returns the area inside the border, The x and y are always zero
|
|
|
|
*
|
|
|
|
* @param aRect on return it holds the x. y, width and height of the client area of this widget
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD GetClientBounds(nsRect &aRect) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets the width and height of the borders
|
|
|
|
* @param aWidth the width of the border
|
|
|
|
* @param aHeight the height of the border
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD GetBorderSize(PRInt32 &aWidth, PRInt32 &aHeight) = 0;
|
|
|
|
|
1998-04-14 00:24:54 +04:00
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Get the foreground color for this widget
|
|
|
|
*
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return this widget's foreground color
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
virtual nscolor GetForegroundColor(void) = 0;
|
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Set the foreground color for this widget
|
|
|
|
*
|
1998-04-14 00:24:54 +04:00
|
|
|
* @param aColor the new foreground color
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetForegroundColor(const nscolor &aColor) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Get the background color for this widget
|
|
|
|
*
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return this widget's background color
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
virtual nscolor GetBackgroundColor(void) = 0;
|
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Set the background color for this widget
|
|
|
|
*
|
1998-04-14 00:24:54 +04:00
|
|
|
* @param aColor the new background color
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetBackgroundColor(const nscolor &aColor) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Get the font for this widget
|
|
|
|
*
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return the font metrics
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
|
|
|
|
|
|
|
virtual nsIFontMetrics* GetFont(void) = 0;
|
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Set the font for this widget
|
|
|
|
*
|
1998-04-15 01:33:43 +04:00
|
|
|
* @param aFont font to display. See nsFont for allowable fonts
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetFont(const nsFont &aFont) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Get the cursor for this widget.
|
|
|
|
*
|
1998-04-15 00:48:14 +04:00
|
|
|
* @return this widget's cursor.
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
|
|
|
|
|
|
|
virtual nsCursor GetCursor(void) = 0;
|
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Set the cursor for this widget
|
|
|
|
*
|
1998-04-15 03:20:49 +04:00
|
|
|
* @param aCursor the new cursor for this widget
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetCursor(nsCursor aCursor) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Invalidate the widget and repaint it.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @param aIsSynchronouse PR_TRUE then repaint synchronously. If PR_FALSE repaint later.
|
1998-10-27 03:16:59 +03:00
|
|
|
* @see #Update()
|
1998-04-14 04:31:59 +04:00
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Invalidate(PRBool aIsSynchronous) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1998-10-09 19:18:54 +04:00
|
|
|
/**
|
|
|
|
* Invalidate a specified rect for a widget and repaints it.
|
|
|
|
*
|
|
|
|
* @param aIsSynchronouse PR_TRUE then repaint synchronously. If PR_FALSE repaint later.
|
1998-10-27 03:16:59 +03:00
|
|
|
* @see #Update()
|
1998-10-09 19:18:54 +04:00
|
|
|
*/
|
|
|
|
|
|
|
|
NS_IMETHOD Invalidate(const nsRect & aRect, PRBool aIsSynchronous) = 0;
|
|
|
|
|
1998-10-27 03:16:59 +03:00
|
|
|
/**
|
|
|
|
* Force a synchronous repaint of the window if there are dirty rects.
|
|
|
|
*
|
|
|
|
* @see Invalidate()
|
|
|
|
*/
|
|
|
|
|
|
|
|
NS_IMETHOD Update() = 0;
|
1998-10-09 19:18:54 +04:00
|
|
|
|
1998-04-14 00:24:54 +04:00
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Adds a mouse listener to this widget
|
|
|
|
* Any existing mouse listener is replaced
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
1998-04-14 04:31:59 +04:00
|
|
|
* @param aListener mouse listener to add to this widget.
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
1998-04-14 04:31:59 +04:00
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD AddMouseListener(nsIMouseListener * aListener) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1999-03-12 07:30:30 +03:00
|
|
|
/**
|
|
|
|
* Adds an event listener to this widget
|
|
|
|
* Any existing event listener is replaced
|
|
|
|
*
|
|
|
|
* @param aListener event listener to add to this widget.
|
|
|
|
*/
|
|
|
|
|
|
|
|
NS_IMETHOD AddEventListener(nsIEventListener * aListener) = 0;
|
|
|
|
|
1999-01-27 18:48:22 +03:00
|
|
|
/**
|
|
|
|
* Adds a menu listener to this widget
|
|
|
|
* Any existing menu listener is replaced
|
|
|
|
*
|
|
|
|
* @param aListener menu listener to add to this widget.
|
|
|
|
*/
|
|
|
|
|
|
|
|
NS_IMETHOD AddMenuListener(nsIMenuListener * aListener) = 0;
|
|
|
|
|
1998-04-14 00:24:54 +04:00
|
|
|
/**
|
|
|
|
* Return the widget's toolkit
|
|
|
|
*
|
1998-04-15 01:33:43 +04:00
|
|
|
* @return the toolkit this widget was created in. See nsToolkit.
|
1998-04-14 00:24:54 +04:00
|
|
|
*/
|
1998-04-14 04:31:59 +04:00
|
|
|
|
1998-04-14 00:24:54 +04:00
|
|
|
virtual nsIToolkit* GetToolkit() = 0;
|
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Set the color map for this widget
|
|
|
|
*
|
|
|
|
* @param aColorMap color map for displaying this widget
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetColorMap(nsColorMap *aColorMap) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
|
|
|
/**
|
1998-04-14 04:31:59 +04:00
|
|
|
* Scroll this widget.
|
1998-04-14 00:24:54 +04:00
|
|
|
*
|
|
|
|
* @param aDx amount to scroll along the x-axis
|
|
|
|
* @param aDy amount to scroll along the y-axis.
|
|
|
|
* @param aClipRect clipping rectangle to limit the scroll to.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD Scroll(PRInt32 aDx, PRInt32 aDy, nsRect *aClipRect) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
|
1998-04-15 01:33:43 +04:00
|
|
|
/**
|
1998-04-14 00:24:54 +04:00
|
|
|
* Internal methods
|
|
|
|
*/
|
1998-04-15 00:59:07 +04:00
|
|
|
|
1998-04-15 01:33:43 +04:00
|
|
|
//@{
|
1998-04-14 04:31:59 +04:00
|
|
|
virtual void AddChild(nsIWidget* aChild) = 0;
|
|
|
|
virtual void RemoveChild(nsIWidget* aChild) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
virtual void* GetNativeData(PRUint32 aDataType) = 0;
|
1999-05-28 03:20:09 +04:00
|
|
|
virtual void FreeNativeData(void * data, PRUint32 aDataType) = 0;//~~~
|
1998-04-14 00:24:54 +04:00
|
|
|
virtual nsIRenderingContext* GetRenderingContext() = 0;
|
|
|
|
virtual nsIDeviceContext* GetDeviceContext() = 0;
|
1998-07-29 22:51:45 +04:00
|
|
|
virtual nsIAppShell *GetAppShell() = 0;
|
1998-04-15 01:33:43 +04:00
|
|
|
//@}
|
1998-04-18 03:45:07 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set border style
|
|
|
|
* Must be called before Create.
|
|
|
|
* @param aBorderStyle @see nsBorderStyle
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetBorderStyle(nsBorderStyle aBorderStyle) = 0;
|
1998-04-18 03:45:07 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the widget's title.
|
|
|
|
* Must be called after Create.
|
|
|
|
*
|
|
|
|
* @param aTitle string displayed as the title of the widget
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetTitle(const nsString& aTitle) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the widget's MenuBar.
|
|
|
|
* Must be called after Create.
|
|
|
|
*
|
1999-06-04 08:00:30 +04:00
|
|
|
* @param aMenuBar the menubar
|
1998-09-29 02:32:48 +04:00
|
|
|
*/
|
|
|
|
|
|
|
|
NS_IMETHOD SetMenuBar(nsIMenuBar * aMenuBar) = 0;
|
1998-04-18 03:45:07 +04:00
|
|
|
|
1999-06-04 08:00:30 +04:00
|
|
|
/**
|
1999-06-09 23:01:55 +04:00
|
|
|
* Set the widget's MenuBar's visibility
|
1999-06-04 08:00:30 +04:00
|
|
|
*
|
|
|
|
* @param aShow PR_TRUE to show, PR_FALSE to hide
|
|
|
|
*/
|
|
|
|
|
|
|
|
NS_IMETHOD ShowMenuBar(PRBool aShow) = 0;
|
|
|
|
|
1999-06-09 23:01:55 +04:00
|
|
|
/**
|
|
|
|
* Query whether the widget's MenuBar is visible
|
|
|
|
*
|
|
|
|
* @param aVisible PR_TRUE if currently visible, PR_FALSE if not
|
|
|
|
*/
|
|
|
|
|
|
|
|
NS_IMETHOD IsMenuBarVisible(PRBool *aVisible) = 0;
|
|
|
|
|
1998-05-04 23:25:25 +04:00
|
|
|
/**
|
|
|
|
* Set the collection of tooltip rectangles.
|
|
|
|
* A NS_SHOW_TOOLTIP event is generated when the mouse hovers over one
|
|
|
|
* of the rectangles. a NS_HIDE_TOOLTIP event is generated when the mouse
|
|
|
|
* is moved or a new tooltip is displayed.
|
|
|
|
*
|
|
|
|
* @param aNumberOfTips number of tooltip areas.
|
|
|
|
* @param aTooltipArea array of x,y,width,height rectangles specifying hot areas
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD SetTooltips(PRUint32 aNumberOfTips,nsRect* aTooltipAreas[]) = 0;
|
1998-05-04 23:25:25 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Update the collection of tooltip rectangles. The number of tooltips must
|
|
|
|
* match the original number of tooltips specified in SetTooltips. Must be called
|
|
|
|
* after calling SetTooltips.
|
|
|
|
*
|
|
|
|
* @param aNewTips array of x,y,width,height rectangles specifying the new hot areas
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD UpdateTooltips(nsRect* aNewTips[]) = 0;
|
1998-05-04 23:25:25 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove the collection of tooltip rectangles.
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD RemoveTooltips() = 0;
|
1998-04-18 03:45:07 +04:00
|
|
|
|
1998-07-09 21:04:31 +04:00
|
|
|
|
1998-05-06 03:41:16 +04:00
|
|
|
/**
|
|
|
|
* Convert from this widget coordinates to screen coordinates.
|
|
|
|
*
|
|
|
|
* @param aOldRect widget coordinates stored in the x,y members
|
|
|
|
* @param aNewRect screen coordinates stored in the x,y members
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD WidgetToScreen(const nsRect& aOldRect, nsRect& aNewRect) = 0;
|
1998-05-06 03:41:16 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Convert from screen coordinates to this widget's coordinates.
|
|
|
|
*
|
|
|
|
* @param aOldRect screen coordinates stored in the x,y members
|
|
|
|
* @param aNewRect widget's coordinates stored in the x,y members
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD ScreenToWidget(const nsRect& aOldRect, nsRect& aNewRect) = 0;
|
1998-05-06 03:41:16 +04:00
|
|
|
|
1998-05-13 07:39:08 +04:00
|
|
|
/**
|
|
|
|
* When adjustments are to made to a whole set of child widgets, call this
|
|
|
|
* before resizing/positioning the child windows to minimize repaints. Must
|
|
|
|
* be followed by EndResizingChildren() after child windows have been
|
|
|
|
* adjusted.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD BeginResizingChildren(void) = 0;
|
1998-05-13 07:39:08 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Call this when finished adjusting child windows. Must be preceded by
|
|
|
|
* BeginResizingChildren().
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
1998-09-29 02:32:48 +04:00
|
|
|
NS_IMETHOD EndResizingChildren(void) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns the preferred width and height for the widget
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD GetPreferredSize(PRInt32& aWidth, PRInt32& aHeight) = 0;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the preferred width and height for the widget
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD SetPreferredSize(PRInt32 aWidth, PRInt32 aHeight) = 0;
|
|
|
|
|
1998-10-07 23:49:36 +04:00
|
|
|
/**
|
|
|
|
* Dispatches and event to the widget
|
|
|
|
*
|
|
|
|
*/
|
1998-10-08 02:11:37 +04:00
|
|
|
NS_IMETHOD DispatchEvent(nsGUIEvent* event, nsEventStatus & aStatus) = 0;
|
1998-10-07 23:49:36 +04:00
|
|
|
|
|
|
|
|
1999-03-05 18:25:21 +03:00
|
|
|
/**
|
|
|
|
* FSets the vertical scrollbar widget
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD SetVerticalScrollbar(nsIWidget * aScrollbar) = 0;
|
|
|
|
|
1998-11-24 17:57:09 +03:00
|
|
|
/**
|
|
|
|
* For printing and lightweight widgets
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD Paint(nsIRenderingContext& aRenderingContext,
|
|
|
|
const nsRect& aDirtyRect) = 0;
|
1998-09-29 02:32:48 +04:00
|
|
|
|
1999-03-10 02:50:40 +03:00
|
|
|
/**
|
|
|
|
* Enables the dropping of files to a widget (XXX this is temporary)
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD EnableFileDrop(PRBool aEnable) = 0;
|
|
|
|
|
1998-09-16 21:18:56 +04:00
|
|
|
virtual void ConvertToDeviceCoordinates(nscoord &aX,nscoord &aY) = 0;
|
1999-06-22 00:37:50 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Enables/Disables system mouse capture.
|
|
|
|
* @param aCapture PR_TRUE enables mouse capture, PR_FALSE disables mouse capture
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
NS_IMETHOD CaptureMouse(PRBool aCapture) = 0;
|
1998-04-14 00:24:54 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // nsIWidget_h__
|