2 * Copyright(c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 using System.ComponentModel;
20 using Tizen.NUI.BaseComponents;
25 /// This is the interface used to draw the border UI.
27 [EditorBrowsable(EditorBrowsableState.Never)]
28 public interface IBorderInterface : IDisposable
31 /// The thickness of the border.
33 [EditorBrowsable(EditorBrowsableState.Never)]
34 public uint BorderLineThickness {get;}
37 /// The thickness of the border's touch area.
39 [EditorBrowsable(EditorBrowsableState.Never)]
40 public uint TouchThickness {get;}
43 /// The height of the border.
44 /// This value is the initial value used when creating borders.
46 [EditorBrowsable(EditorBrowsableState.Never)]
47 public float BorderHeight {get;}
50 /// The minimum size by which the window will small.
52 [EditorBrowsable(EditorBrowsableState.Never)]
53 public Size2D MinSize {get;}
56 /// The maximum size by which the window will big.
58 [EditorBrowsable(EditorBrowsableState.Never)]
59 public Size2D MaxSize {get;}
62 /// The window with borders added.
64 [EditorBrowsable(EditorBrowsableState.Never)]
65 public Window BorderWindow {get; set;}
68 /// Whether overlay mode.
69 /// If overlay mode is true, the border area is hidden when the window is maximized.
70 /// And if you touched at screen, the border area is shown on the screen.
71 /// Default value is false;
73 [EditorBrowsable(EditorBrowsableState.Never)]
74 public bool OverlayMode {get;}
77 /// Set the window resizing policy.
79 [EditorBrowsable(EditorBrowsableState.Never)]
80 public Window.BorderResizePolicyType ResizePolicy {get;}
83 /// Create top border UI. User can override this method to draw top border UI.
85 /// <param name="topView">The top view on which the border.</param>
86 [EditorBrowsable(EditorBrowsableState.Never)]
87 public bool CreateTopBorderView(View topView);
90 /// Create bottom border UI. User can override this method to draw bottom border UI.
92 /// <param name="bottomView">The bottom view on which the border.</param>
93 [EditorBrowsable(EditorBrowsableState.Never)]
94 public bool CreateBottomBorderView(View bottomView);
97 /// Create border UI. User can override this method to draw border UI.
98 /// A top border and a bottom border are added to this view.
100 /// <param name="borderView">The border view on which the border.</param>
101 [EditorBrowsable(EditorBrowsableState.Never)]
102 public void CreateBorderView(View borderView);
105 /// Called after the border UI is created.
107 /// <param name="borderView">The border view on which the border.</param>
108 [EditorBrowsable(EditorBrowsableState.Never)]
109 public void OnCreated(View borderView);
112 /// Called when the window is resized.
114 /// <param name="width">The width of the resized window</param>
115 /// <param name="height">The height of the resized window</param>
116 [EditorBrowsable(EditorBrowsableState.Never)]
117 public void OnResized(int width, int height);
120 /// Called when the window is moved.
122 /// <param name="x">The x of the moved window</param>
123 /// <param name="y">The y of the moved window</param>
124 [EditorBrowsable(EditorBrowsableState.Never)]
125 public void OnMoved(int x, int y);
128 /// Called when window has been moved the display server.
130 /// <param name="x">The x of the has been moved window</param>
131 /// <param name="y">The y of the has been moved window</param>
132 [EditorBrowsable(EditorBrowsableState.Never)]
133 public void OnMoveCompleted(int x, int y);
136 /// Called when window has been resized the display server.
138 /// <param name="width">The width of the resized window</param>
139 /// <param name="height">The height of the resized window</param>
140 [EditorBrowsable(EditorBrowsableState.Never)]
141 public void OnResizeCompleted(int width, int height);
144 /// Called when the window is maximized.
146 /// <param name="isMaximized">If window is maximized or unmaximized.</param>
147 [EditorBrowsable(EditorBrowsableState.Never)]
148 public void OnMaximize(bool isMaximized);
151 /// Called when the window is minimized.
153 /// <param name="isMinimized">If window is minimized or unminimized.</param>
154 [EditorBrowsable(EditorBrowsableState.Never)]
155 public void OnMinimize(bool isMinimized);
158 /// Called when there is a change in overlay mode.
160 /// <param name="enabled">If true, borderView has entered overlayMode.</param>
161 [EditorBrowsable(EditorBrowsableState.Never)]
162 public void OnOverlayMode(bool enabled);