pjs/view/public/nsIViewManager.h

501 строка
16 KiB
C
Исходник Обычный вид История

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.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
1998-04-14 00:24:54 +04:00
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
1998-04-14 00:24:54 +04:00
*/
#ifndef nsIViewManager_h___
#define nsIViewManager_h___
#include "nscore.h"
#include "nsISupports.h"
#include "nsCoord.h"
#include "nsIView.h"
class nsIRegion;
1998-04-14 00:24:54 +04:00
class nsIEvent;
class nsIPresContext;
class nsIView;
class nsIScrollableView;
1998-04-14 00:24:54 +04:00
class nsIWidget;
Fix for bug #15360: Drag Selecting, Clicking, then Clicking leaves caret cruft. r=troy@netscape.com,kipp@netscape.com,evaughan@netscape.com,beard@netscape.com layout/html/base/src/nsGfxScrollFrame.cpp - Renamed all occurrences of ScrollPositionChanged() to to ScrollPositionDidChange() to match changes made to nsIScrollPositionListener. - Added ScrollPositionWillChange() stub method. layout/html/base/src/nsPresShell.cpp - Added PresShellViewEventListener class that implements the nsIScrollPositionListener and nsICompositeListener view interfaces. This allows us to turn caret rendering on and off when scrolling and repainting to prevent leaving caret cruft on the screen. - PresShellViewEventListener is created in InitialReflow(), and released in ~PresShell(). view/public/Makefile.in view/public/makefile.win view/public/MANIFEST - Added nsICompositeListener to list of files to be exported. view/public/nsICompositeListener.h - New file. Implementers of this interface can register themselves with the view manager to receive notification before and after a view is composited/refreshed. view/public/nsIScrollPositionListener.h - Added a ScrollPositionWillChange() method. - Changed ScrollPositionChanged() to ScrollPositionDidChange(). view/public/nsIViewManager.h - Added AddCompositeListener() and RemoveCompositeListener methods. view/src/nsScrollingView.cpp view/src/nsScrollingView.h - Added NotifyScrollPositionWillChange() and NotifyScrollPositionDidChange() methods. - Modified HandleScrollEvent() to call NotifyScrollPositionWill/DidChange() methods. Added temporary offsetX and offsetY variables to allow us to calculate new offsets without changing mOffsetX and mOffsetY before notifications are sent out. view/src/nsScrollPortView.cpp - Changed ScrollPositionChanged() to ScrollPositionDidChange(). - Modified ScrollTo() to call the listener's ScrollPositionWillChange() method. view/src/nsViewManager.cpp view/src/nsViewManager.h - Added AddCompositeListener() and RemoveCompositeListener() methods. - Added support for CompositeListener notifications in the Refresh() methods for regions and rects. - Fix for bug #15901: [DOGFOOD] Selected text does not clear when you type Modified UpdateView() so that rects with zero width and height are no longer added to our damage region. r=beard@netscape.com
1999-10-15 08:29:30 +04:00
class nsICompositeListener;
1998-04-14 00:24:54 +04:00
struct nsRect;
enum nsContentQuality {
1998-06-21 05:23:44 +04:00
nsContentQuality_kGood = 0,
nsContentQuality_kFair,
nsContentQuality_kPoor,
nsContentQuality_kUnknown
};
1998-06-21 05:23:44 +04:00
1998-04-14 00:24:54 +04:00
#define NS_IVIEWMANAGER_IID \
{ 0x3a8863d0, 0xa7f3, 0x11d1, \
{ 0xa8, 0x24, 0x00, 0x40, 0x95, 0x9a, 0x28, 0xc9 } }
class nsIViewManager : public nsISupports
{
public:
static const nsIID& GetIID() { static nsIID iid = NS_IVIEWMANAGER_IID; return iid; }
1998-04-16 00:25:02 +04:00
/**
* Initialize the ViewManager
* Note: this instance does not hold a reference to the viewobserver
* because it holds a reference to this instance.
* @param aContext the device context to use.
* @param aX X offset of the view manager's coordinate space in twips
* @param aY Y offset of the view manager's coordinate space in twips
1998-04-16 00:25:02 +04:00
* @result The result of the initialization, NS_OK if no errors
*/
NS_IMETHOD Init(nsIDeviceContext* aContext, nscoord aX = 0, nscoord aY = 0) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Get the root of the view tree.
* @result the root view
*/
NS_IMETHOD GetRootView(nsIView *&aView) = 0;
1998-04-16 00:25:02 +04:00
/**
* Set the root of the view tree. Does not destroy the current root view.
* One of following must be true:
* a) the aWidget parameter is an nsIWidget instance to render into
* that is not owned by any view or
* b) aView has a nsIWidget instance or
* c) aView has a parent view managed by a different view manager
1998-04-16 00:25:02 +04:00
* @param aView view to set as root
* @param aWidget widget to render into. (Can not be owned by a view)
1998-04-16 00:25:02 +04:00
*/
NS_IMETHOD SetRootView(nsIView *aView, nsIWidget* aWidget = nsnull) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Get the current framerate i.e. the rate at which timed
* refreshes occur. A framerate of 0 indicates that timed refreshes
* should not occur. framerate is in terms of frames per second
* @result the update rate in terms of frames per second
*/
NS_IMETHOD GetFrameRate(PRUint32& aRate) = 0;
1998-04-16 00:25:02 +04:00
/**
* Set the current framerate.
* @param frameRate new update rate. see GetFrameRate for more info
* @result the call may need to create a timer and the success
* status will be returned. NS_OK means all is well
*/
NS_IMETHOD SetFrameRate(PRUint32 frameRate) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Get the dimensions of the root window. The dimensions are in
* twips
* @param width out parameter for width of window in twips
* @param height out parameter for height of window in twips
*/
NS_IMETHOD GetWindowDimensions(nscoord *width, nscoord *height) = 0;
1998-04-16 00:25:02 +04:00
/**
* Set the dimensions of the root window.
* Called if the root window is resized. The dimensions are in
* twips
* @param width of window in twips
* @param height of window in twips
*/
NS_IMETHOD SetWindowDimensions(nscoord width, nscoord height) = 0;
1998-04-14 00:24:54 +04:00
/**
* Reset the state of scrollbars and the scrolling region
*/
NS_IMETHOD ResetScrolling(void) = 0;
1998-04-16 00:25:02 +04:00
/**
* Called to force a redrawing of any dirty areas.
*/
NS_IMETHOD Composite(void) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Called to inform the view manager that the entire area of a view
* is dirty and needs to be redrawn.
1998-04-16 00:25:02 +04:00
* @param aView view to paint. should be root view
* @param aUpdateFlags see bottom of nsIViewManager.h for description
*/
NS_IMETHOD UpdateView(nsIView *aView, PRUint32 aUpdateFlags) = 0;
1998-04-16 00:25:02 +04:00
/**
* Called to inform the view manager that some portion of a view
* is dirty and needs to be redrawn. The rect passed in
* should be in the view's coordinate space.
* @param aView view to paint. should be root view
* @param rect rect to mark as damaged
* @param aUpdateFlags see bottom of nsIViewManager.h for description
*/
NS_IMETHOD UpdateView(nsIView *aView, const nsRect &aRect, PRUint32 aUpdateFlags) = 0;
1998-04-14 00:24:54 +04:00
/**
* Called to inform the view manager that it should redraw all views.
* @param aView view to paint. should be root view
* @param aUpdateFlags see bottom of nsIViewManager.h for description
*/
NS_IMETHOD UpdateAllViews(PRUint32 aUpdateFlags) = 0;
1998-04-16 00:25:02 +04:00
/**
* Called to dispatch an event to the appropriate view. Often called
* as a result of receiving a mouse or keyboard event from the widget
* event system.
* @param event event to dispatch
* @result event handling status
*/
NS_IMETHOD DispatchEvent(nsGUIEvent *aEvent, nsEventStatus* aStatus) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Used to grab/capture all mouse events for a specific view,
* irrespective of the cursor position at which the
* event occurred.
* @param aView view to capture mouse events
* @result event handling status
*/
NS_IMETHOD GrabMouseEvents(nsIView *aView, PRBool& aResult) = 0;
1998-04-16 00:25:02 +04:00
/**
* Used to grab/capture all keyboard events for a specific view,
* irrespective of the cursor position at which the
* event occurred.
* @param aView view to capture keyboard events
* @result event handling status
*/
NS_IMETHOD GrabKeyEvents(nsIView *aView, PRBool& aResult) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Get the current view, if any, that's capturing mouse events.
* @result view that is capturing mouse events or nsnull
*/
NS_IMETHOD GetMouseEventGrabber(nsIView *&aView) = 0;
1998-04-16 00:25:02 +04:00
/**
* Get the current view, if any, that's capturing keyboard events.
* @result view that is capturing keyboard events or nsnull
*/
NS_IMETHOD GetKeyEventGrabber(nsIView *&aView) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Given a parent view, insert another view as its child. If above
* is PR_TRUE, the view is inserted above (in z-order) the sibling. If
* it is PR_FALSE, the view is inserted below.
* The view manager generates the appopriate dirty regions.
* @param parent parent view
* @param child child view
* @param sibling sibling view
* @param above boolean above or below state
*/
NS_IMETHOD InsertChild(nsIView *aParent, nsIView *aChild, nsIView *aSibling,
PRBool aAbove) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Given a parent view, insert another view as its child. The zindex
* indicates where the child should be inserted relative to other
* children of the parent.
* The view manager generates the appopriate dirty regions.
* @param parent parent view
* @param child child view
* @param zindex z depth of child
*/
NS_IMETHOD InsertChild(nsIView *aParent, nsIView *aChild,
PRInt32 aZIndex) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Remove a specific child of a view.
* The view manager generates the appopriate dirty regions.
* @param parent parent view
* @param child child view
*/
NS_IMETHOD RemoveChild(nsIView *aParent, nsIView *aChild) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Move a view's position by the specified amount.
* The view manager generates the appopriate dirty regions.
* @param aView view to move
* @param x x offset to add to current view position
* @param y y offset to add to current view position
*/
NS_IMETHOD MoveViewBy(nsIView *aView, nscoord aX, nscoord aY) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Move a view to the specified position,
* provided in parent coordinates.
* The view manager generates the appopriate dirty regions.
* @param aView view to move
* @param x x value for new view position
* @param y y value for new view position
*/
NS_IMETHOD MoveViewTo(nsIView *aView, nscoord aX, nscoord aY) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Resize a view to the specified width and height.
* The view manager generates the appopriate dirty regions.
* @param aView view to move
* @param width new view width
* @param height new view height
*/
NS_IMETHOD ResizeView(nsIView *aView, nscoord aWidth, nscoord aHeight) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Set the clip of a view.
* The view manager generates the appopriate dirty regions.
* @param aView view to to clip rect on
* @param rect new clipping rect for view
*/
NS_IMETHOD SetViewClip(nsIView *aView, nsRect *aRect) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Set the visibility of a view.
* The view manager generates the appopriate dirty regions.
* @param aView view to change visibility state of
* @param visible new visibility state
*/
NS_IMETHOD SetViewVisibility(nsIView *aView, nsViewVisibility aVisible) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Set the z-index of a view. Positive z-indices mean that a view
* is above its parent in z-order. Negative z-indices mean that a
* view is below its parent.
* The view manager generates the appopriate dirty regions.
* @param aView view to change z depth of
* @param zindex new z depth
*/
NS_IMETHOD SetViewZIndex(nsIView *aView, PRInt32 aZindex) = 0;
1998-04-14 00:24:54 +04:00
/**
* Indicate that the z-index of a view is "auto". An "auto" z-index
* means that the view does not define a new stacking context,
* which means that the z-indicies of the view's children are
* relative to the view's siblings.
* The view manager generates the appopriate dirty regions.
* @param aView view to change z depth of
* @param zindex new z depth
*/
NS_IMETHOD SetViewAutoZIndex(nsIView *aView, PRBool aAutoZIndex) = 0;
1998-04-16 00:25:02 +04:00
/**
* Used to move a view above another in z-order.
* The view manager generates the appopriate dirty regions.
* @param aView view to change z depth of
* @param other view to move aView above
*/
NS_IMETHOD MoveViewAbove(nsIView *aView, nsIView *aOther) = 0;
1998-04-16 00:25:02 +04:00
/**
* Used to move a view below another in z-order.
* The view manager generates the appopriate dirty regions.
* @param aView view to change z depth of
* @param other view to move aView below
*/
NS_IMETHOD MoveViewBelow(nsIView *aView, nsIView *aOther) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Returns whether a view is actually shown (based on its visibility
* and that of its ancestors).
* @param aView view to query visibilty of
* @result PR_TRUE if visible, else PR_FALSE
*/
NS_IMETHOD IsViewShown(nsIView *aView, PRBool &aResult) = 0;
1998-04-14 00:24:54 +04:00
1998-04-16 00:25:02 +04:00
/**
* Returns the clipping area of a view in absolute coordinates.
* @param aView view to query clip rect of
* @param rect to set with view's clipping rect
* @result PR_TRUE if there is a clip rect, else PR_FALSE
*/
NS_IMETHOD GetViewClipAbsolute(nsIView *aView, nsRect *aRect, PRBool &aResult) = 0;
1998-04-14 00:24:54 +04:00
/**
* Used set the transparency status of the content in a view. see
* nsIView.HasTransparency().
* @param aTransparent PR_TRUE if there are transparent areas, PR_FALSE otherwise.
*/
NS_IMETHOD SetViewContentTransparency(nsIView *aView, PRBool aTransparent) = 0;
/**
* Note: This didn't exist in 4.0. Called to set the opacity of a view.
* A value of 0.0 means completely transparent. A value of 1.0 means
* completely opaque.
* @param opacity new opacity value
*/
NS_IMETHOD SetViewOpacity(nsIView *aView, float aOpacity) = 0;
1998-04-16 00:25:02 +04:00
/**
* Set the view observer associated with this manager
* @param aObserver - new observer
* @result error status
1998-04-16 00:25:02 +04:00
*/
NS_IMETHOD SetViewObserver(nsIViewObserver *aObserver) = 0;
/**
* Get the view observer associated with this manager
* @param aObserver - out parameter for observer
* @result error status
*/
NS_IMETHOD GetViewObserver(nsIViewObserver *&aObserver) = 0;
/**
* Get the device context associated with this manager
* @result device context
*/
NS_IMETHOD GetDeviceContext(nsIDeviceContext *&aContext) = 0;
1998-04-14 00:24:54 +04:00
1998-06-21 05:23:44 +04:00
/**
* Select whether quality level should be displayed in root view
* @param aShow if PR_TRUE, quality level will be displayed, else hidden
*/
NS_IMETHOD ShowQuality(PRBool aShow) = 0;
1998-06-21 05:23:44 +04:00
/**
* Query whether quality level should be displayed in view frame
* @return if PR_TRUE, quality level will be displayed, else hidden
*/
NS_IMETHOD GetShowQuality(PRBool &aResult) = 0;
1998-06-21 05:23:44 +04:00
/**
* Select whether quality level should be displayed in root view
* @param aShow if PR_TRUE, quality level will be displayed, else hidden
*/
NS_IMETHOD SetQuality(nsContentQuality aQuality) = 0;
/**
* prevent the view manager from refreshing.
* @return error status
*/
NS_IMETHOD DisableRefresh(void) = 0;
/**
* allow the view manager to refresh. this may cause a synchronous
* paint to occur inside the call.
* @param aUpdateFlags see bottom of nsIViewManager.h for description
* @return error status
*/
NS_IMETHOD EnableRefresh(PRUint32 aUpdateFlags) = 0;
1998-11-14 04:58:34 +03:00
/**
* prevents the view manager from refreshing. allows UpdateView()
* to notify widgets of damaged regions that should be repainted
* when the batch is ended.
* @return error status
*/
NS_IMETHOD BeginUpdateViewBatch(void) = 0;
/**
* allow the view manager to refresh any damaged areas accumulated
* after the BeginUpdateViewBatch() call. this may cause a
* synchronous paint to occur inside the call if aUpdateFlags NS_VMREFRESH_IMMEDIATE is set
* @param aUpdateFlags see bottom of nsIViewManager.h for description
* @return error status
*/
NS_IMETHOD EndUpdateViewBatch(PRUint32 aUpdateFlags) = 0;
/**
* set the view that is is considered to be the root scrollable
* view for the document.
* @param aScrollable root scrollable view
* @return error status
*/
NS_IMETHOD SetRootScrollableView(nsIScrollableView *aScrollable) = 0;
/**
* get the view that is is considered to be the root scrollable
* view for the document.
* @param aScrollable out parameter for root scrollable view
* @return error status
*/
NS_IMETHOD GetRootScrollableView(nsIScrollableView **aScrollable) = 0;
/**
* Display the specified view. Used when printing.
*/
NS_IMETHOD Display(nsIView *aView) = 0;
Fix for bug #15360: Drag Selecting, Clicking, then Clicking leaves caret cruft. r=troy@netscape.com,kipp@netscape.com,evaughan@netscape.com,beard@netscape.com layout/html/base/src/nsGfxScrollFrame.cpp - Renamed all occurrences of ScrollPositionChanged() to to ScrollPositionDidChange() to match changes made to nsIScrollPositionListener. - Added ScrollPositionWillChange() stub method. layout/html/base/src/nsPresShell.cpp - Added PresShellViewEventListener class that implements the nsIScrollPositionListener and nsICompositeListener view interfaces. This allows us to turn caret rendering on and off when scrolling and repainting to prevent leaving caret cruft on the screen. - PresShellViewEventListener is created in InitialReflow(), and released in ~PresShell(). view/public/Makefile.in view/public/makefile.win view/public/MANIFEST - Added nsICompositeListener to list of files to be exported. view/public/nsICompositeListener.h - New file. Implementers of this interface can register themselves with the view manager to receive notification before and after a view is composited/refreshed. view/public/nsIScrollPositionListener.h - Added a ScrollPositionWillChange() method. - Changed ScrollPositionChanged() to ScrollPositionDidChange(). view/public/nsIViewManager.h - Added AddCompositeListener() and RemoveCompositeListener methods. view/src/nsScrollingView.cpp view/src/nsScrollingView.h - Added NotifyScrollPositionWillChange() and NotifyScrollPositionDidChange() methods. - Modified HandleScrollEvent() to call NotifyScrollPositionWill/DidChange() methods. Added temporary offsetX and offsetY variables to allow us to calculate new offsets without changing mOffsetX and mOffsetY before notifications are sent out. view/src/nsScrollPortView.cpp - Changed ScrollPositionChanged() to ScrollPositionDidChange(). - Modified ScrollTo() to call the listener's ScrollPositionWillChange() method. view/src/nsViewManager.cpp view/src/nsViewManager.h - Added AddCompositeListener() and RemoveCompositeListener() methods. - Added support for CompositeListener notifications in the Refresh() methods for regions and rects. - Fix for bug #15901: [DOGFOOD] Selected text does not clear when you type Modified UpdateView() so that rects with zero width and height are no longer added to our damage region. r=beard@netscape.com
1999-10-15 08:29:30 +04:00
/**
* Add a listener to the view manager's composite listener list.
* @param aListener - new listener
* @result error status
*/
NS_IMETHOD AddCompositeListener(nsICompositeListener *aListener) = 0;
/**
* Remove a listener from the view manager's composite listener list.
* @param aListener - listener to remove
* @result error status
*/
NS_IMETHOD RemoveCompositeListener(nsICompositeListener *aListener) = 0;
/**
* Retrieve the widget that a view renders into.
* @param aView the view to get the widget for
* @param aWidget the widget that aView renders into.
* @result error status
*/
NS_IMETHOD GetWidgetForView(nsIView *aView, nsIWidget **aWidget) = 0;
/**
* Retrieve the widget that a view manager renders into
* @param aWidget the widget that aView renders into.
* @result error status
*/
NS_IMETHOD GetWidget(nsIWidget **aWidget) = 0;
/**
* Force update of view manager widget
* Callers should use UpdateView(view, NS_VMREFRESH_IMMEDIATE) in most cases instead
* @result error status
*/
NS_IMETHOD ForceUpdate() = 0;
/**
* Get view manager offset specified in nsIViewManager::Init
* @param aX x offset in twips
* @param aY y offset in twips
* @result error status
*/
NS_IMETHOD GetOffset(nscoord *aX, nscoord *aY) = 0;
/**
* Turn widget on or off widget movement caching
*/
NS_IMETHOD IsCachingWidgetChanges(PRBool* aCaching)=0;
/**
* Pass true to cache widget changes. pass false to stop. When false is passed
* All widget changes will be applied.
*/
NS_IMETHOD CacheWidgetChanges(PRBool aCache)=0;
1998-04-14 00:24:54 +04:00
};
//when the refresh happens, should it be double buffered?
#define NS_VMREFRESH_DOUBLE_BUFFER 0x0001
1998-04-14 00:24:54 +04:00
//update view now?
#define NS_VMREFRESH_IMMEDIATE 0x0002
//prevent "sync painting"
#define NS_VMREFRESH_NO_SYNC 0x0004
//if the total damage area is greater than 25% of the
//area of the root view, use double buffering
#define NS_VMREFRESH_AUTO_DOUBLE_BUFFER 0x0008
1998-04-14 00:24:54 +04:00
#endif // nsIViewManager_h___