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
{
{
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 */
-/* 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);