mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 14:45:29 +00:00
376 lines
10 KiB
C++
376 lines
10 KiB
C++
/* -*- 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"
|
|
#include "nsIImage.h"
|
|
|
|
#include "prthread.h"
|
|
#include "nsGUIEvent.h"
|
|
|
|
// forward declarations
|
|
class nsIToolkit;
|
|
class nsIFontMetrics;
|
|
class nsIToolkit;
|
|
class nsIRenderingContext;
|
|
class nsIEnumerator;
|
|
class nsIDeviceContext;
|
|
class nsIPresContext;
|
|
struct nsRect;
|
|
struct nsFont;
|
|
|
|
/**
|
|
* Callback function that deals with events.
|
|
* 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.
|
|
* @see getNativeData()
|
|
*/
|
|
#define NS_NATIVE_WINDOW 0
|
|
#define NS_NATIVE_GRAPHIC 1
|
|
#define NS_NATIVE_COLORMAP 2
|
|
|
|
// {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
|
|
// including native window system types and api's. This is necessary
|
|
// to ensure cross-platform code.
|
|
typedef void* nsNativeWindow;
|
|
|
|
|
|
/**
|
|
* Cursor types.
|
|
* eCursor_standard (normal cursor, usually rendered as an arrow)
|
|
* eCursor_wait (system is busy, usually rendered as a hourglass or watch)
|
|
* eCursor_select (Selecting something, usually rendered as an IBeam)
|
|
* eCursor_hyperlink (can hyper-link, usually rendered as a human hand)
|
|
*/
|
|
|
|
enum nsCursor { eCursor_standard,
|
|
eCursor_wait,
|
|
eCursor_select,
|
|
eCursor_hyperlink };
|
|
|
|
/**
|
|
* The base class for all the widgets. It provides the interface for all basic and
|
|
* necessary functionality.
|
|
*/
|
|
class nsIWidget : public nsISupports {
|
|
|
|
public:
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param parent or null if it's a top level window
|
|
* @param aRect the widget dimension
|
|
* @param aHandleEventFunction the event handler callback function
|
|
*
|
|
*/
|
|
virtual void Create(nsIWidget *aParent,
|
|
const nsRect &aRect,
|
|
EVENT_CALLBACK aHandleEventFunction,
|
|
nsIDeviceContext *aContext,
|
|
nsIToolkit *aToolkit = nsnull) = 0;
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* 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.
|
|
*
|
|
* @param aParent native window.
|
|
* @param aRect the widget dimension
|
|
* @param aHandleEventFunction the event handler callback function
|
|
*
|
|
*/
|
|
virtual void Create(nsNativeWindow aParent,
|
|
const nsRect &aRect,
|
|
EVENT_CALLBACK aHandleEventFunction,
|
|
nsIDeviceContext *aContext,
|
|
nsIToolkit *aToolkit = nsnull) = 0;
|
|
|
|
/**
|
|
* Close and destroy the internal native window.
|
|
* This method does not delete the widget.
|
|
*/
|
|
|
|
virtual void Destroy(void) = 0;
|
|
|
|
/**
|
|
* Return the parent Widget of this Widget or nsnull if this is a
|
|
* top level window
|
|
*
|
|
* @return the parent widget or nsnull if it does not have a parent
|
|
*
|
|
*/
|
|
virtual nsIWidget* GetParent(void) = 0;
|
|
|
|
/**
|
|
* Return an nsEnumerator over the children of this widget.
|
|
*
|
|
* @return an enumerator over the list of children or nsnull if it does not
|
|
* have any children
|
|
*
|
|
*/
|
|
virtual nsIEnumerator* GetChildren(void) = 0;
|
|
|
|
/**
|
|
* Show or hide this widget
|
|
*
|
|
* @param aState PR_TRUE to show the Widget, PR_FALSE to hide it
|
|
*
|
|
*/
|
|
virtual void Show(PRBool aState) = 0;
|
|
|
|
/**
|
|
* Move this widget.
|
|
*
|
|
* @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
|
|
*
|
|
**/
|
|
virtual void Move(PRUint32 aX, PRUint32 aY) = 0;
|
|
|
|
/**
|
|
* Resize this widget.
|
|
*
|
|
* @param aWidth the new width expressed in the parent's coordinate system
|
|
* @param aHeight the new height expressed in the parent's coordinate system
|
|
*
|
|
*/
|
|
virtual void Resize(PRUint32 aWidth,
|
|
PRUint32 aHeight) = 0;
|
|
|
|
/**
|
|
* Move or resize this widget.
|
|
*
|
|
* @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
|
|
*
|
|
*/
|
|
virtual void Resize(PRUint32 aX,
|
|
PRUint32 aY,
|
|
PRUint32 aWidth,
|
|
PRUint32 aHeight) = 0;
|
|
|
|
/**
|
|
* Enable or disable this Widget
|
|
*
|
|
* @param aState PR_TRUE to enable the Widget, PR_FALSE to disable it.
|
|
*
|
|
*/
|
|
virtual void Enable(PRBool aState) = 0;
|
|
|
|
/**
|
|
* Give focus to this widget.
|
|
*/
|
|
virtual void SetFocus(void) = 0;
|
|
|
|
/**
|
|
* Get this widget's dimension
|
|
*
|
|
* @param aRect on return it holds the x. y, width and height of this widget
|
|
*
|
|
*/
|
|
virtual void GetBounds(nsRect &aRect) = 0;
|
|
|
|
/**
|
|
* Get the foreground color for this widget
|
|
*
|
|
* @return this widget's foreground color
|
|
*
|
|
*/
|
|
virtual nscolor GetForegroundColor(void) = 0;
|
|
|
|
/**
|
|
* Set the foreground color for this widget
|
|
*
|
|
* @param aColor the new foreground color
|
|
*
|
|
*/
|
|
|
|
virtual void SetForegroundColor(const nscolor &aColor) = 0;
|
|
|
|
/**
|
|
* Get the background color for this widget
|
|
*
|
|
* @return this widget's background color
|
|
*
|
|
*/
|
|
|
|
virtual nscolor GetBackgroundColor(void) = 0;
|
|
|
|
/**
|
|
* Set the background color for this widget
|
|
*
|
|
* @param aColor the new background color
|
|
*
|
|
*/
|
|
|
|
virtual void SetBackgroundColor(const nscolor &aColor) = 0;
|
|
|
|
/**
|
|
* Get the font for this widget
|
|
*
|
|
* @return the font metrics
|
|
*/
|
|
|
|
virtual nsIFontMetrics* GetFont(void) = 0;
|
|
|
|
/**
|
|
* Set the font for this widget
|
|
*
|
|
* @param aFont font to display. @see nsFont for allowable fonts
|
|
*/
|
|
|
|
virtual void SetFont(const nsFont &aFont) = 0;
|
|
|
|
/**
|
|
* Get the cursor for this widget.
|
|
*
|
|
* @return this widget's cursor.
|
|
*/
|
|
|
|
virtual nsCursor GetCursor(void) = 0;
|
|
|
|
/**
|
|
* Set the cursor for this widget
|
|
*
|
|
* @aCursor the new cursor for this widget
|
|
*/
|
|
|
|
virtual void SetCursor(nsCursor aCursor) = 0;
|
|
|
|
/**
|
|
* Invalidate the widget and repaint it.
|
|
*
|
|
* @param aIsSynchronouse PR_TRUE then repaint synchronously. If PR_FALSE repaint later.
|
|
*
|
|
*/
|
|
|
|
virtual void Invalidate(PRBool aIsSynchronous) = 0;
|
|
|
|
|
|
/**
|
|
* Adds a mouse listener to this widget
|
|
* Any existing mouse listener is replaced
|
|
*
|
|
* @param aListener mouse listener to add to this widget.
|
|
*/
|
|
|
|
virtual void AddMouseListener(nsIMouseListener * aListener) = 0;
|
|
|
|
/**
|
|
* Return the widget's toolkit
|
|
*
|
|
* @return the toolkit this widget was created in. @see nsToolkit.
|
|
*/
|
|
|
|
virtual nsIToolkit* GetToolkit() = 0;
|
|
|
|
/**
|
|
* Set the color map for this widget
|
|
*
|
|
* @param aColorMap color map for displaying this widget
|
|
*
|
|
*/
|
|
|
|
virtual void SetColorMap(nsColorMap *aColorMap) = 0;
|
|
|
|
/**
|
|
* Scroll this widget.
|
|
*
|
|
* @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.
|
|
*
|
|
*/
|
|
|
|
virtual void Scroll(PRInt32 aDx, PRInt32 aDy, nsRect *aClipRect) = 0;
|
|
|
|
/*
|
|
* Internal methods
|
|
*/
|
|
|
|
/**
|
|
* Internal Method
|
|
*/
|
|
virtual void AddChild(nsIWidget* aChild) = 0;
|
|
|
|
/**
|
|
* Internal Method
|
|
*/
|
|
virtual void RemoveChild(nsIWidget* aChild) = 0;
|
|
|
|
/**
|
|
* Internal Method
|
|
*/
|
|
virtual void* GetNativeData(PRUint32 aDataType) = 0;
|
|
|
|
/**
|
|
* Internal Method
|
|
*/
|
|
virtual nsIRenderingContext* GetRenderingContext() = 0;
|
|
|
|
/**
|
|
* Internal Method
|
|
*/
|
|
virtual nsIDeviceContext* GetDeviceContext() = 0;
|
|
|
|
|
|
};
|
|
|
|
#endif // nsIWidget_h__
|