X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fwindows.h;h=28239961c2d713aa337b9b313733fd1a740347bf;hb=a71cdad2127723325c5ab170c1cd1dfa7075b0a3;hp=03d44b693e4fdb65e04c5a31a95bae1ab4fd2779;hpb=566ddf894142085e3f0208a08fa36ccce6d6a6ea;p=plomrogue

diff --git a/src/windows.h b/src/windows.h
index 03d44b6..2823996 100644
--- a/src/windows.h
+++ b/src/windows.h
@@ -47,8 +47,8 @@
 struct Frame
 {
     WINDOW * curses_win;
-    struct yx_uint16 size;        /* designated size of curses_win */
-};
+    struct yx_uint16 size;  /* the size curses_win fits into; for the virtual */
+};                          /* screen padframe: the terminal screen size      */
 
 struct Win
 {
@@ -71,7 +71,7 @@ struct WinMeta
 {
     WINDOW * screen;          /* terminal screen */
     uint16_t pad_offset;      /* number of cells view is moved to the right */
-    struct Frame pad;         /* virtual screen */
+    struct Frame padframe;    /* virtual screen fitted into terminal screen */
     struct Win * chain_start; /* first Win, whose .prev shall point to 0 */
     struct Win * chain_end;   /* last Win, whose .next shall point to 0 */
     struct Win * active;      /* window highlighted/selected for manipulation */
@@ -79,27 +79,29 @@ struct WinMeta
 
 
 
-/* Create on the terminal "screen" an empty WinMeta whose virtual screen at the
- * beginning is sized just like the terminal screen. Note that emptiness is
- * marked by WinMeta.chain_start=0. Other struct values are also initialized 0.
- *
- * TODO: Why is an *empty* virtual screen's size that of the terminal screen?
+/* Create on the terminal "screen" an empty WinMeta. Note that emptiness is
+ * marked by WinMeta.chain_start=0. Other struct values are also initialized 0,
+ * except for the virtual screen (terminal screen height, width = 1) and its
+ * terminal-sized frame.
  */
 extern struct WinMeta init_win_meta(WINDOW * screen);
 
 
 
-/* Create a window below inside "wmeta" titled "title" and appointing "func"()
- * to interpret and draw the content stored at "data" if the window is visible.
+/* Create a window below inside "wmeta" titled "title" of "height" and "width"
+ * and appointing "func"() to interpret and draw the content stored at "data"
+ * if the window is visible.
  *
- * The start size for the Frame will be a width of 20 cells and a height one
- * less than the height of the virtual screen (so as to fit the title bar on top
- * of the window). Other values will be initialized to 0. The window will stay
- * invisible until appended to the chain of visible windows via append_win().
+ * A value for "width" <1 will trigger a fallback to width=1. A "height" <1 or
+ * larger than the maximum window height possible within the virtual screen will
+ * trigger a fallback to the maximum height possible (i.e. pass a "height" of 0
+ * to initialize the window to its largest possible height).
  *
- * TODO: Why a default start width instead of passing a start width?
+ * Other values of the Win struct will be initialized to 0. The window will stay
+ * invisible until appended to the chain of visible windows via append_win().
  */
 extern struct Win init_win(struct WinMeta * wmeta, char * title,
+                           uint16_t height, uint16_t widtht,
                            void * data, void * func);