pjs/widget/public/nsIWidget.h

870 строки
27 KiB
C
Исходник Обычный вид История

/* -*- 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
1998-04-14 00:24:54 +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/
1998-04-14 00:24:54 +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.
1998-04-14 00:24:54 +04:00
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* 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 ***** */
1998-04-14 00:24:54 +04:00
#ifndef nsIWidget_h__
#define nsIWidget_h__
#include "nsISupports.h"
#include "nsColor.h"
#include "nsIMouseListener.h"
#include "nsIMenuListener.h"
#include "nsCoord.h"
1998-04-14 00:24:54 +04:00
#include "prthread.h"
#include "nsEvent.h"
#include "nsString.h"
1998-04-14 00:24:54 +04:00
1998-04-14 04:31:59 +04:00
// forward declarations
class nsIAppShell;
1998-04-14 04:31:59 +04:00
class nsIToolkit;
class nsIFontMetrics;
class nsIToolkit;
class nsIRenderingContext;
class nsIEnumerator;
class nsIDeviceContext;
class nsIRegion;
1998-04-14 04:31:59 +04:00
struct nsRect;
struct nsFont;
class nsIMenuBar;
1999-03-12 07:30:30 +03:00
class nsIEventListener;
1999-09-21 15:22:21 +04:00
class nsIRollupListener;
struct nsGUIEvent;
struct nsColorMap;
1999-09-21 15:22:21 +04:00
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
#define NS_NATIVE_WIDGET 3
#define NS_NATIVE_DISPLAY 4
1998-08-27 21:31:59 +04:00
#define NS_NATIVE_REGION 5
#define NS_NATIVE_OFFSETX 6
#define NS_NATIVE_OFFSETY 7
1999-03-12 07:30:30 +03:00
#define NS_NATIVE_PLUGIN_PORT 8
#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.
typedef void* nsNativeWidget;
1998-04-14 00:24:54 +04:00
/**
* Border styles
*/
1999-07-27 08:27:17 +04:00
enum nsWindowType {
// default top level window
eWindowType_toplevel,
// top level window but usually handled differently by the OS
eWindowType_dialog,
// used for combo boxes, etc
eWindowType_popup,
// child windows (contained inside a window on the desktop (has no border))
eWindowType_child,
// windows that are invisible or offscreen
eWindowType_invisible
1999-07-27 08:27:17 +04:00
};
enum nsBorderStyle
{
// no border, titlebar, etc.. opposite of all
1999-07-27 08:27:17 +04:00
eBorderStyle_none = 0,
1999-07-27 08:27:17 +04:00
// all window decorations
eBorderStyle_all = 1 << 0,
// enables the border on the window. these are only for decoration and are not resize hadles
1999-07-27 08:27:17 +04:00
eBorderStyle_border = 1 << 1,
// enables the resize handles for the window. if this is set, border is implied to also be set
1999-07-27 08:27:17 +04:00
eBorderStyle_resizeh = 1 << 2,
// enables the titlebar for the window
1999-07-27 08:27:17 +04:00
eBorderStyle_title = 1 << 3,
// enables the window menu button on the title bar. this being on should force the title bar to display
1999-07-27 08:27:17 +04:00
eBorderStyle_menu = 1 << 4,
// enables the minimize button so the user can minimize the window.
// turned off for tranient windows since they can not be minimized seperate from their parent
1999-07-27 08:27:17 +04:00
eBorderStyle_minimize = 1 << 5,
// enables the maxmize button so the user can maximize the window
1999-07-27 08:27:17 +04:00
eBorderStyle_maximize = 1 << 6,
1999-07-27 08:27:17 +04:00
// show the close button
eBorderStyle_close = 1 << 7,
// sheet hint (Mac OS X)
eBorderStyle_sheet = 1 << 8,
1999-07-27 08:27:17 +04:00
// whatever the OS wants... i.e. don't do anything
eBorderStyle_default = -1
};
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)
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,
///(corner sizing)
eCursor_sizeNW,
eCursor_sizeSE,
eCursor_sizeNE,
eCursor_sizeSW,
1998-08-07 19:35:27 +04:00
eCursor_arrow_north,
eCursor_arrow_north_plus,
eCursor_arrow_south,
eCursor_arrow_south_plus,
eCursor_arrow_west,
eCursor_arrow_west_plus,
eCursor_arrow_east,
eCursor_arrow_east_plus,
eCursor_crosshair,
//Don't know what 'move' cursor should be. See CSS2.
eCursor_move,
2000-05-07 09:14:43 +04:00
eCursor_help,
eCursor_copy, // CSS3
eCursor_alias,
eCursor_context_menu,
eCursor_cell,
eCursor_grab,
eCursor_grabbing,
eCursor_spinning,
eCursor_count_up,
eCursor_count_down,
eCursor_count_up_down
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
*/
struct nsWidgetInitData {
nsWidgetInitData()
: clipChildren(PR_FALSE),
clipSiblings(PR_FALSE),
mDropShadow(PR_FALSE),
1999-07-27 08:27:17 +04:00
mWindowType(eWindowType_child),
mBorderStyle(eBorderStyle_default)
{
}
// when painting exclude area occupied by child windows and sibling windows
PRPackedBool clipChildren, clipSiblings, mDropShadow;
1999-07-27 08:27:17 +04:00
nsWindowType mWindowType;
nsBorderStyle mBorderStyle;
};
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
NS_DEFINE_STATIC_IID_ACCESSOR(NS_IWIDGET_IID)
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
* @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-14 04:31:59 +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,
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-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
*/
NS_IMETHOD Create(nsNativeWidget aParent,
const nsRect &aRect,
EVENT_CALLBACK aHandleEventFunction,
1998-04-14 00:24:54 +04:00
nsIDeviceContext *aContext,
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
/**
* 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.
*/
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
*/
NS_IMETHOD Show(PRBool aState) = 0;
/**
* Make the window modal
*
*/
NS_IMETHOD SetModal(PRBool aModal) = 0;
/**
* Returns whether the window is visible
*
*/
NS_IMETHOD IsVisible(PRBool & aState) = 0;
1998-04-14 00:24:54 +04:00
/**
* Perform platform-dependent sanity check on a potential window position.
* This is guaranteed to work only for top-level windows.
*
* @param aAllowSlop: if true, allow the window to slop offscreen;
* the window should be partially visible. if false,
* force the entire window onscreen (or at least
* the upper-left corner, if it's too large).
* @param aX in: an x position expressed in screen coordinates.
* out: the x position constrained to fit on the screen(s).
* @param aY in: an y position expressed in screen coordinates.
* out: the y position constrained to fit on the screen(s).
* @return vapid success indication. but see also the parameters.
*
**/
NS_IMETHOD ConstrainPosition(PRBool aAllowSlop,
PRInt32 *aX,
PRInt32 *aY) = 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
*
**/
NS_IMETHOD Move(PRInt32 aX, PRInt32 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
* @param aRepaint whether the widget should be repainted
1998-04-14 00:24:54 +04:00
*
*/
NS_IMETHOD Resize(PRInt32 aWidth,
PRInt32 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
*
* @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
*
*/
NS_IMETHOD Resize(PRInt32 aX,
PRInt32 aY,
PRInt32 aWidth,
PRInt32 aHeight,
PRBool aRepaint) = 0;
1998-04-14 00:24:54 +04:00
/**
* Sets the widget's z-index.
*/
NS_IMETHOD SetZIndex(PRInt32 aZIndex) = 0;
/**
* Gets the widget's z-index.
*/
NS_IMETHOD GetZIndex(PRInt32* aZIndex) = 0;
2000-04-02 02:10:22 +04:00
/**
* Position this widget just behind the given widget. (Used to
* control z-order for top-level widgets. Get/SetZIndex by contrast
* control z-order for child widgets of other widgets.)
* null aWidget means put on top.
*/
NS_IMETHOD PlaceBehind(nsIWidget *aWidget, PRBool aActivate) = 0;
2000-04-02 02:10:22 +04:00
/**
* Minimize, maximize or normalize the window size.
* Takes a value from nsSizeMode (see nsGUIEvent.h)
*/
NS_IMETHOD SetSizeMode(PRInt32 aMode) = 0;
/**
* Return size mode (minimized, maximized, normalized).
* Returns a value from nsSizeMode (see nsGUIEvent.h)
*/
NS_IMETHOD GetSizeMode(PRInt32* aMode) = 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
*
*/
NS_IMETHOD Enable(PRBool aState) = 0;
1998-04-14 00:24:54 +04:00
/*
* Ask whether the widget is enabled
* @param aState returns PR_TRUE if the widget is enabled
*/
NS_IMETHOD IsEnabled(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
*/
NS_IMETHOD SetFocus(PRBool aRaise = PR_FALSE) = 0;
1998-04-14 00:24:54 +04:00
/**
* Get this widget's outside dimensions relative to its parent widget
1998-04-14 00:24:54 +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
*
*/
NS_IMETHOD GetBounds(nsRect &aRect) = 0;
/**
* Get this widget's outside dimensions in global coordinates. (One might think this
* could be accomplished by stringing together other methods in this interface, but
* then one would bloody one's nose on different coordinate system handling by different
* platforms.)
*
* @param aRect on return it holds the x, y, width and height of this widget
*
*/
NS_IMETHOD GetScreenBounds(nsRect &aRect) = 0;
/**
* 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
*
*/
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
*
*/
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
*/
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
*
* @param aCursor the new cursor for this widget
1998-04-14 00:24:54 +04:00
*/
NS_IMETHOD SetCursor(nsCursor aCursor) = 0;
1998-04-14 00:24:54 +04:00
/**
* Get the window type of this widget
*
* @param aWindowType the window type of the widget
*/
NS_IMETHOD GetWindowType(nsWindowType& aWindowType) = 0;
/**
* Hide window chrome (borders, buttons) for this widget.
*
*/
NS_IMETHOD HideWindowChrome(PRBool aShouldHide) = 0;
2001-05-02 02:50:16 +04:00
/**
* Validate the widget.
*
*/
NS_IMETHOD Validate() = 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.
* @see #Update()
1998-04-14 04:31:59 +04:00
*/
NS_IMETHOD Invalidate(PRBool aIsSynchronous) = 0;
1998-04-14 00:24: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.
* @see #Update()
*/
NS_IMETHOD Invalidate(const nsRect & aRect, PRBool aIsSynchronous) = 0;
/**
* Invalidate a specified region for a widget and repaints it.
*
* @param aIsSynchronouse PR_TRUE then repaint synchronously. If PR_FALSE repaint later.
* @see #Update()
*/
NS_IMETHOD InvalidateRegion(const nsIRegion* aRegion, PRBool aIsSynchronous) = 0;
/**
* Force a synchronous repaint of the window if there are dirty rects.
*
* @see Invalidate()
*/
NS_IMETHOD Update() = 0;
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
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;
/**
* 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
*
*/
NS_IMETHOD SetColorMap(nsColorMap *aColorMap) = 0;
1998-04-14 00:24:54 +04:00
/**
* XXX (This is obsolete and will be removed soon, Use ScrollWidgets instead)
* 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.
*
*/
NS_IMETHOD Scroll(PRInt32 aDx, PRInt32 aDy, nsRect *aClipRect) = 0;
1998-04-14 00:24:54 +04:00
/**
* Scroll the contents of the widget.
* All child widgets are also scrolled by offsetting their coordinates.
* A NS_PAINT message is synchronously dispatched for the newly exposed rectangle.
*
* @param aDx amount to scroll along the x-axis in pixels
* @param aDy amount to scroll along the y-axis in pixels
*
*/
NS_IMETHOD ScrollWidgets(PRInt32 aDx, PRInt32 aDy) = 0;
/**
* Scroll an area of this widget. Child widgets are not scrolled.
* A NS_PAINT message is synchronously dispatched for the newly exposed rectangle.
*
* @param aRect source rectangle to scroll in the widget in pixels
* @param aDx x offset from the source in pixels
* @param aDy y offset from the source in pixels
*
*/
NS_IMETHOD ScrollRect(nsRect &aSrcRect, PRInt32 aDx, PRInt32 aDy) = 0;
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;
virtual nsIAppShell *GetAppShell() = 0;
1998-04-15 01:33:43 +04:00
//@}
/**
* Set border style
* Must be called before Create.
* @param aBorderStyle @see nsBorderStyle
*/
NS_IMETHOD SetBorderStyle(nsBorderStyle aBorderStyle) = 0;
/**
* Set the widget's title.
* Must be called after Create.
*
* @param aTitle string displayed as the title of the widget
*/
NS_IMETHOD SetTitle(const nsString& aTitle) = 0;
/**
* Set the widget's icon.
* Must be called after Create.
*
* @param anIconSpec string specifying the icon to use; convention is to pass
* a resource: URL from which a platform-dependent resource
* file name will be constructed
*/
NS_IMETHOD SetIcon(const nsAString& anIconSpec) = 0;
/**
* Set the widget's MenuBar.
* Must be called after Create.
*
1999-06-04 08:00:30 +04:00
* @param aMenuBar the menubar
*/
NS_IMETHOD SetMenuBar(nsIMenuBar * aMenuBar) = 0;
1999-06-04 08:00:30 +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;
/**
* 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
*/
NS_IMETHOD WidgetToScreen(const nsRect& aOldRect, nsRect& aNewRect) = 0;
/**
* 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
*/
NS_IMETHOD ScreenToWidget(const nsRect& aOldRect, nsRect& aNewRect) = 0;
/**
* 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.
*
*/
NS_IMETHOD BeginResizingChildren(void) = 0;
/**
* Call this when finished adjusting child windows. Must be preceded by
* BeginResizingChildren().
*
*/
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
*
*/
NS_IMETHOD DispatchEvent(nsGUIEvent* event, nsEventStatus & aStatus) = 0;
1998-10-07 23:49:36 +04:00
/**
* For printing and lightweight widgets
*
*/
NS_IMETHOD Paint(nsIRenderingContext& aRenderingContext,
const nsRect& aDirtyRect) = 0;
1999-03-10 02:50:40 +03:00
/**
* Enables the dropping of files to a widget (XXX this is temporary)
*
*/
NS_IMETHOD EnableDragDrop(PRBool aEnable) = 0;
1999-03-10 02:50:40 +03:00
1998-09-16 21:18:56 +04:00
virtual void ConvertToDeviceCoordinates(nscoord &aX,nscoord &aY) = 0;
/**
* Enables/Disables system mouse capture.
* @param aCapture PR_TRUE enables mouse capture, PR_FALSE disables mouse capture
*
*/
NS_IMETHOD CaptureMouse(PRBool aCapture) = 0;
1999-09-21 15:22:21 +04:00
/**
* Enables/Disables system capture of any and all events that would cause a
* dropdown to be rolled up, This method ignores the aConsumeRollupEvent
* parameter when aDoCapture is FALSE
* @param aCapture PR_TRUE enables capture, PR_FALSE disables capture
* @param aConsumeRollupEvent PR_TRUE consumes the rollup event, PR_FALSE dispatches rollup event
*
*/
NS_IMETHOD CaptureRollupEvents(nsIRollupListener * aListener, PRBool aDoCapture, PRBool aConsumeRollupEvent) = 0;
/**
* Determine whether a given event should be processed assuming we are
* the currently active modal window.
* Note that the exact semantics of this method are platform-dependent.
* The Macintosh, for instance, cares deeply that this method do exactly
* as advertised. Gtk, for instance, handles modality in a completely
* different fashion and does little if anything with this method.
* @param aRealEvent event is real or a null placeholder (Macintosh)
* @param aEvent void pointer to native event structure
* @param aForWindow return value. PR_TRUE iff event should be processed.
*/
NS_IMETHOD ModalEventFilter(PRBool aRealEvent, void *aEvent, PRBool *aForWindow) = 0;
/**
* Bring this window to the user's attention. This is intended to be a more
* gentle notification than popping the window to the top or putting up an
* alert. See, for example, Win32 FlashWindow or the NotificationManager on
* the Mac. The notification should be suppressed if the window is already
* in the foreground and should be dismissed when the user brings this window
* to the foreground.
*/
NS_IMETHOD GetAttention() = 0;
1998-04-14 00:24:54 +04:00
};
#endif // nsIWidget_h__