UNPKG

1.84 kBTypeScriptView Raw
1import { ISignal } from '@lumino/signaling';
2import { Panel } from './panel';
3import { StackedLayout } from './stackedlayout';
4import { Widget } from './widget';
5/**
6 * A panel where visible widgets are stacked atop one another.
7 *
8 * #### Notes
9 * This class provides a convenience wrapper around a [[StackedLayout]].
10 */
11export declare class StackedPanel extends Panel {
12 /**
13 * Construct a new stacked panel.
14 *
15 * @param options - The options for initializing the panel.
16 */
17 constructor(options?: StackedPanel.IOptions);
18 /**
19 * The method for hiding widgets.
20 *
21 * #### Notes
22 * If there is only one child widget, `Display` hiding mode will be used
23 * regardless of this setting.
24 */
25 /**
26 * Set the method for hiding widgets.
27 *
28 * #### Notes
29 * If there is only one child widget, `Display` hiding mode will be used
30 * regardless of this setting.
31 */
32 hiddenMode: Widget.HiddenMode;
33 /**
34 * A signal emitted when a widget is removed from a stacked panel.
35 */
36 readonly widgetRemoved: ISignal<this, Widget>;
37 /**
38 * A message handler invoked on a `'child-added'` message.
39 */
40 protected onChildAdded(msg: Widget.ChildMessage): void;
41 /**
42 * A message handler invoked on a `'child-removed'` message.
43 */
44 protected onChildRemoved(msg: Widget.ChildMessage): void;
45 private _widgetRemoved;
46}
47/**
48 * The namespace for the `StackedPanel` class statics.
49 */
50export declare namespace StackedPanel {
51 /**
52 * An options object for creating a stacked panel.
53 */
54 interface IOptions {
55 /**
56 * The stacked layout to use for the stacked panel.
57 *
58 * The default is a new `StackedLayout`.
59 */
60 layout?: StackedLayout;
61 }
62}
63//# sourceMappingURL=stackedpanel.d.ts.map
\No newline at end of file