mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-31 22:25:30 +00:00
325 lines
12 KiB
C++
325 lines
12 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 nsIPresShell_h___
|
|
#define nsIPresShell_h___
|
|
|
|
#include "nslayout.h"
|
|
#include "nsISupports.h"
|
|
#include "nsCoord.h"
|
|
#include "nsIDOMSelection.h"
|
|
|
|
class nsIContent;
|
|
class nsIDocument;
|
|
class nsIDocumentObserver;
|
|
class nsIFrame;
|
|
class nsIPresContext;
|
|
class nsIStyleSet;
|
|
class nsIViewManager;
|
|
class nsIReflowCommand;
|
|
class nsIDeviceContext;
|
|
class nsIRenderingContext;
|
|
class nsIPageSequenceFrame;
|
|
class nsString;
|
|
class nsStringArray;
|
|
class nsICaret;
|
|
class nsIStyleContext;
|
|
class nsIFrameSelection;
|
|
class nsIFrameManager;
|
|
|
|
#define NS_IPRESSHELL_IID \
|
|
{ 0x76e79c60, 0x944e, 0x11d1, \
|
|
{0x93, 0x23, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
|
|
|
|
// Constants uses for ScrollFrameIntoView() function
|
|
#define NS_PRESSHELL_SCROLL_TOP 0
|
|
#define NS_PRESSHELL_SCROLL_BOTTOM 100
|
|
#define NS_PRESSHELL_SCROLL_LEFT 0
|
|
#define NS_PRESSHELL_SCROLL_RIGHT 100
|
|
#define NS_PRESSHELL_SCROLL_CENTER 50
|
|
#define NS_PRESSHELL_SCROLL_ANYWHERE -1
|
|
|
|
typedef enum SelectionType{SELECTION_NORMAL = 0,
|
|
SELECTION_SPELLCHECK,
|
|
SELECTION_IME_SOLID,
|
|
SELECTION_IME_DASHED,
|
|
NUM_SELECTIONTYPES} SelectionType;
|
|
|
|
|
|
/**
|
|
* Presentation shell interface. Presentation shells are the
|
|
* controlling point for managing the presentation of a document. The
|
|
* presentation shell holds a live reference to the document, the
|
|
* presentation context, the style manager, the style set and the root
|
|
* frame. <p>
|
|
*
|
|
* When this object is Release'd, it will release the document, the
|
|
* presentation context, the style manager, the style set and the root
|
|
* frame.
|
|
*/
|
|
class nsIPresShell : public nsISupports {
|
|
public:
|
|
static const nsIID& GetIID() { static nsIID iid = NS_IPRESSHELL_IID; return iid; }
|
|
|
|
NS_IMETHOD Init(nsIDocument* aDocument,
|
|
nsIPresContext* aPresContext,
|
|
nsIViewManager* aViewManager,
|
|
nsIStyleSet* aStyleSet) = 0;
|
|
|
|
NS_IMETHOD GetDocument(nsIDocument** aResult) = 0;
|
|
|
|
NS_IMETHOD GetPresContext(nsIPresContext** aResult) = 0;
|
|
|
|
NS_IMETHOD GetViewManager(nsIViewManager** aResult) = 0;
|
|
|
|
NS_IMETHOD GetStyleSet(nsIStyleSet** aResult) = 0;
|
|
|
|
NS_IMETHOD GetActiveAlternateStyleSheet(nsString& aSheetTitle) = 0;
|
|
|
|
NS_IMETHOD SelectAlternateStyleSheet(const nsString& aSheetTitle) = 0;
|
|
|
|
/**
|
|
* Gather titles of all selectable (alternate and preferred) style sheets
|
|
* fills void array with nsString* caller must free strings
|
|
*/
|
|
NS_IMETHOD ListAlternateStyleSheets(nsStringArray& aTitleList) = 0;
|
|
|
|
/**
|
|
* GetSelection will return the selection that the presentation
|
|
* shell may implement.
|
|
*
|
|
* @param aSelection will hold the return value
|
|
*/
|
|
NS_IMETHOD GetSelection(SelectionType aType, nsIDOMSelection** aSelection) = 0;
|
|
|
|
/**
|
|
* GetFrameSelection will return the Frame based selection API you
|
|
* cannot go back and forth anymore with QI with nsIDOM sel and nsIFrame sel.
|
|
*/
|
|
NS_IMETHOD GetFrameSelection(nsIFrameSelection** aSelection) = 0;
|
|
|
|
NS_IMETHOD EnterReflowLock() = 0;
|
|
|
|
NS_IMETHOD ExitReflowLock() = 0;
|
|
|
|
// Make shell be a document observer
|
|
NS_IMETHOD BeginObservingDocument() = 0;
|
|
|
|
// Make shell stop being a document observer
|
|
NS_IMETHOD EndObservingDocument() = 0;
|
|
|
|
/**
|
|
* Perform the initial reflow. Constructs the frame for the root content
|
|
* object and then reflows the frame model into the specified width and
|
|
* height.
|
|
*
|
|
* The coordinates for aWidth and aHeight must be in standard nscoord's.
|
|
*/
|
|
NS_IMETHOD InitialReflow(nscoord aWidth, nscoord aHeight) = 0;
|
|
|
|
/**
|
|
* Reflow the frame model into a new width and height. The
|
|
* coordinates for aWidth and aHeight must be in standard nscoord's.
|
|
*/
|
|
NS_IMETHOD ResizeReflow(nscoord aWidth, nscoord aHeight) = 0;
|
|
|
|
/**
|
|
* Reflow the frame model with a reflow reason of eReflowReason_StyleChange
|
|
*/
|
|
NS_IMETHOD StyleChangeReflow() = 0;
|
|
|
|
NS_IMETHOD GetRootFrame(nsIFrame** aFrame) const = 0;
|
|
|
|
/**
|
|
* Returns the page sequence frame associated with the frame hierarchy.
|
|
* Returns NULL if not a paginated view.
|
|
*/
|
|
NS_IMETHOD GetPageSequenceFrame(nsIPageSequenceFrame** aResult) const = 0;
|
|
|
|
/**
|
|
* Get/set the primary frame associated with the content object.
|
|
*
|
|
* The primary frame is the frame that is most closely associated with the
|
|
* content. A frame is more closely associated with the content that another
|
|
* frame if the one frame contains directly or indirectly the other frame (e.g.,
|
|
* when a frame is scrolled there is a scroll frame that contains the frame
|
|
* being scrolled). The primary frame is always the first-in-flow.
|
|
*
|
|
* In the case of absolutely positioned elements and floated elements,
|
|
* the primary frame is the frame that is out of the flow and not the
|
|
* placeholder frame.
|
|
*/
|
|
NS_IMETHOD GetPrimaryFrameFor(nsIContent* aContent,
|
|
nsIFrame** aPrimaryFrame) const = 0;
|
|
NS_IMETHOD SetPrimaryFrameFor(nsIContent* aContent,
|
|
nsIFrame* aPrimaryFrame) = 0;
|
|
NS_IMETHOD ClearPrimaryFrameMap() = 0;
|
|
|
|
/** Returns the style context associated with the frame.
|
|
* Used by code outside of layout that can't use nsIFrame methods to get
|
|
* the style context directly.
|
|
*/
|
|
NS_IMETHOD GetStyleContextFor(nsIFrame* aFrame,
|
|
nsIStyleContext** aStyleContext) const = 0;
|
|
|
|
/**
|
|
* Returns a layout object associated with the primary frame for the content object.
|
|
*
|
|
* @param aContent the content object for which we seek a layout object
|
|
* @param aResult the resulting layout object as an nsISupports, if found. Refcounted.
|
|
*/
|
|
NS_IMETHOD GetLayoutObjectFor(nsIContent* aContent,
|
|
nsISupports** aResult) const = 0;
|
|
|
|
/**
|
|
* Get/Set the placeholder frame associated with the specified frame.
|
|
*
|
|
* Out of flow frames (e.g., absolutely positioned frames and floated frames)
|
|
* can have placeholder frames that are inserted into the flow and indicate
|
|
* where the frame would be if it were part of the flow
|
|
*/
|
|
NS_IMETHOD GetPlaceholderFrameFor(nsIFrame* aFrame,
|
|
nsIFrame** aPlaceholderFrame) const = 0;
|
|
NS_IMETHOD SetPlaceholderFrameFor(nsIFrame* aFrame,
|
|
nsIFrame* aPlaceholderFrame) = 0;
|
|
NS_IMETHOD ClearPlaceholderFrameMap() = 0;
|
|
|
|
/**
|
|
* Reflow commands
|
|
*/
|
|
NS_IMETHOD AppendReflowCommand(nsIReflowCommand* aReflowCommand) = 0;
|
|
NS_IMETHOD CancelReflowCommand(nsIFrame* aTargetFrame) = 0;
|
|
NS_IMETHOD ProcessReflowCommands() = 0;
|
|
|
|
NS_IMETHOD ClearFrameRefs(nsIFrame* aFrame) = 0;
|
|
|
|
/**
|
|
* Given a frame, create a rendering context suitable for use with
|
|
* the frame.
|
|
*/
|
|
NS_IMETHOD CreateRenderingContext(nsIFrame *aFrame,
|
|
nsIRenderingContext** aContext) = 0;
|
|
|
|
/**
|
|
* Notification that we were unable to render a replaced element.
|
|
* Called when the replaced element can not be rendered, and we should
|
|
* instead render the element's contents.
|
|
* The content object associated with aFrame should either be a IMG
|
|
* element, an OBJECT element, or an APPLET element
|
|
*/
|
|
NS_IMETHOD CantRenderReplacedElement(nsIPresContext* aPresContext,
|
|
nsIFrame* aFrame) = 0;
|
|
|
|
|
|
/**
|
|
* Scrolls the view of the document so that the anchor with the specified
|
|
* name is displayed at the top of the window
|
|
*/
|
|
NS_IMETHOD GoToAnchor(const nsString& aAnchorName) const = 0;
|
|
|
|
/**
|
|
* Scrolls the view of the document so that the frame is displayed at the
|
|
* top of the window.
|
|
*
|
|
* @param aFrame The frame to scroll into view
|
|
* @param aVPercent How to align the frame vertically. A value of 0
|
|
* (NS_PRESSHELL_SCROLL_TOP) means the frame's upper edge is
|
|
* aligned with the top edge of the visible area. A value of
|
|
* 100 (NS_PRESSHELL_SCROLL_BOTTOM) means the frame's bottom
|
|
* edge is aligned with the bottom edge of the visible area.
|
|
* For values in between, the point "aVPercent" down the frame
|
|
* is placed at the point "aVPercent" down the visible area. A
|
|
* value of 50 (NS_PRESSHELL_SCROLL_CENTER) centers the frame
|
|
* vertically. A value of NS_PRESSHELL_SCROLL_ANYWHERE means move
|
|
* the frame the minimum amount necessary in order for the entire
|
|
* frame to be visible vertically (if possible)
|
|
* @param aHPercent How to align the frame horizontally. A value of 0
|
|
* (NS_PRESSHELL_SCROLL_LEFT) means the frame's left edge is
|
|
* aligned with the left edge of the visible area. A value of
|
|
* 100 (NS_PRESSHELL_SCROLL_RIGHT) means the frame's right
|
|
* edge is aligned with the right edge of the visible area.
|
|
* For values in between, the point "aVPercent" across the frame
|
|
* is placed at the point "aVPercent" across the visible area.
|
|
* A value of 50 (NS_PRESSHELL_SCROLL_CENTER) centers the frame
|
|
* horizontally . A value of NS_PRESSHELL_SCROLL_ANYWHERE means move
|
|
* the frame the minimum amount necessary in order for the entire
|
|
* frame to be visible horizontally (if possible)
|
|
*/
|
|
NS_IMETHOD ScrollFrameIntoView(nsIFrame *aFrame,
|
|
PRIntn aVPercent,
|
|
PRIntn aHPercent) const = 0;
|
|
|
|
/**
|
|
* Notification sent by a frame informing the pres shell that it is about to
|
|
* be destroyed.
|
|
* This allows any outstanding references to the frame to be cleaned up
|
|
*/
|
|
NS_IMETHOD NotifyDestroyingFrame(nsIFrame* aFrame) = 0;
|
|
|
|
/**
|
|
* Returns the frame manager object
|
|
*/
|
|
NS_IMETHOD GetFrameManager(nsIFrameManager** aFrameManager) const = 0;
|
|
|
|
/**
|
|
* Notify the Clipboard that we have something to copy.
|
|
*/
|
|
NS_IMETHOD DoCopy() = 0;
|
|
|
|
/**
|
|
* Get the caret, if it exists. AddRefs it.
|
|
*/
|
|
NS_IMETHOD GetCaret(nsICaret **outCaret) = 0;
|
|
|
|
/**
|
|
* Set the caret as enabled or disabled. An enabled caret will
|
|
* draw orblink when made visible. A disabled caret will never show up.
|
|
*/
|
|
NS_IMETHOD SetCaretEnabled(PRBool inEnable) = 0;
|
|
|
|
/**
|
|
* Should the images have borders ect.
|
|
*/
|
|
NS_IMETHOD SetDisplayNonTextSelection(PRBool inEnable) = 0;
|
|
|
|
NS_IMETHOD GetDisplayNonTextSelection(PRBool *inEnable) = 0;
|
|
// XXX events
|
|
// XXX selection
|
|
|
|
/**
|
|
* See if reflow verification is enabled. To enable reflow verification add
|
|
* "verifyreflow:1" to your NSPR_LOG_MODULES environment variable
|
|
* (any non-zero debug level will work). Or, call SetVerifyReflowEnable
|
|
* with PR_TRUE.
|
|
*/
|
|
static NS_LAYOUT PRBool GetVerifyReflowEnable();
|
|
|
|
/**
|
|
* Set the verify-reflow enable flag.
|
|
*/
|
|
static NS_LAYOUT void SetVerifyReflowEnable(PRBool aEnabled);
|
|
};
|
|
|
|
/**
|
|
* Create a new empty presentation shell. Upon success, call Init
|
|
* before attempting to use the shell.
|
|
*/
|
|
extern NS_LAYOUT nsresult
|
|
NS_NewPresShell(nsIPresShell** aInstancePtrResult);
|
|
|
|
#endif /* nsIPresShell_h___ */
|