Source code

Revision control

Other Tools

1
/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2
*
3
* This Source Code Form is subject to the terms of the Mozilla Public
4
* License, v. 2.0. If a copy of the MPL was not distributed with this
5
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6
7
#include "nsISupports.idl"
8
9
/**
10
* The nsIDocShellTreeOwner
11
*/
12
13
interface nsIDocShellTreeItem;
14
interface nsIRemoteTab;
15
16
[scriptable, uuid(0e3dc4b1-4cea-4a37-af71-79f0afd07574)]
17
interface nsIDocShellTreeOwner : nsISupports
18
{
19
/**
20
* Called when a content shell is added to the docshell tree. This is
21
* _only_ called for "root" content shells (that is, ones whose parent is a
22
* chrome shell).
23
*
24
* @param aContentShell the shell being added.
25
* @param aPrimary whether the shell is primary.
26
*/
27
void contentShellAdded(in nsIDocShellTreeItem aContentShell,
28
in boolean aPrimary);
29
30
/**
31
* Called when a content shell is removed from the docshell tree. This is
32
* _only_ called for "root" content shells (that is, ones whose parent is a
33
* chrome shell). Note that if aContentShell was never added,
34
* contentShellRemoved should just do nothing.
35
*
36
* @param aContentShell the shell being removed.
37
*/
38
void contentShellRemoved(in nsIDocShellTreeItem aContentShell);
39
40
/*
41
Returns the Primary Content Shell
42
*/
43
readonly attribute nsIDocShellTreeItem primaryContentShell;
44
45
void remoteTabAdded(in nsIRemoteTab aTab, in boolean aPrimary);
46
void remoteTabRemoved(in nsIRemoteTab aTab);
47
48
/*
49
In multiprocess case we may not have primaryContentShell but
50
primaryRemoteTab.
51
*/
52
readonly attribute nsIRemoteTab primaryRemoteTab;
53
54
/*
55
Tells the tree owner to size its window or parent window in such a way
56
that the shell passed along will be the size specified.
57
*/
58
[can_run_script]
59
void sizeShellTo(in nsIDocShellTreeItem shell, in long cx, in long cy);
60
61
/*
62
Gets the size of the primary content area in CSS pixels. This should work
63
for both in-process and out-of-process content areas.
64
*/
65
void getPrimaryContentSize(out long width, out long height);
66
/*
67
Sets the size of the primary content area in CSS pixels. This should work
68
for both in-process and out-of-process content areas.
69
*/
70
void setPrimaryContentSize(in long width, in long height);
71
72
/*
73
Gets the size of the root docshell in CSS pixels.
74
*/
75
void getRootShellSize(out long width, out long height);
76
/*
77
Sets the size of the root docshell in CSS pixels.
78
*/
79
void setRootShellSize(in long width, in long height);
80
81
/*
82
Sets the persistence of different attributes of the window.
83
*/
84
void setPersistence(in boolean aPersistPosition,
85
in boolean aPersistSize,
86
in boolean aPersistSizeMode);
87
88
/*
89
Gets the current persistence states of the window.
90
*/
91
void getPersistence(out boolean aPersistPosition,
92
out boolean aPersistSize,
93
out boolean aPersistSizeMode);
94
95
/*
96
Gets the number of tabs currently open in our window, assuming
97
this tree owner has such a concept.
98
*/
99
readonly attribute unsigned long tabCount;
100
101
/*
102
Returns true if there is a primary content shell or a primary
103
remote tab.
104
*/
105
readonly attribute bool hasPrimaryContent;
106
};