X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fwindows.h;h=38bb72949d8cacd392570b84d483a34fdf518810;hb=f4ced5cf0092cc3a945d73a8950baecb23374d23;hp=2116b7bef605ae875504ef1e732f089b60f41444;hpb=f5d7b724bd9572a918f3f8a1803a23648458a07c;p=plomrogue diff --git a/src/windows.h b/src/windows.h index 2116b7b..38bb729 100644 --- a/src/windows.h +++ b/src/windows.h @@ -114,7 +114,7 @@ extern struct Win init_win(struct WinMeta * wmeta, char * title, -/* Append/suspend window "w" to/from chain of visible windows in "wmeta". +/* Append/suspend window "w" to/from chain of visible windows below "wmeta". * Appended windows will become active. Suspended active windows will move the * active window selection to their successor in the window chain or, failing * that, their predecessor; if no window remains, none will be active. @@ -136,21 +136,24 @@ extern void reset_pad_offset(struct WinMeta * wmeta, uint16_t new_offset); /* Apply new size "size" to the active window, but only if it provides for at * least one cell width/height and is in height at least one cell smaller than - * the screen's vertical height (to provide space for the title bar). + * the screen's vertical height (to provide space for the title bar). Does + * nothing if no window is active. */ extern uint8_t resize_active_win(struct WinMeta * wmeta, struct yx_uint16 size); -/* Cycle active window selection forwards (set dir="n") or backwards. Wrap - * around in the windows chain if start / end of it is met. +/* Cycle active window selection forwards ("dir" == "f") or backwards (any + * other "dir"). Wrap around in the windows chain if start / end of it is met. + * Does nothing if no window is active. */ extern void cycle_active_win(struct WinMeta * wmeta, char dir); -/* Move active window forwards (set dir="f") or backwards (set dir="b"). Wrap - * around in the window chain if start / end of it is met. +/* Move active window forwards ("dir" == "f") or backwards (any other "dir"). + * Wrap around in the window chain if start / end of it is met. Does nothing if + * no window is active. */ extern uint8_t shift_active_win(struct WinMeta * wmeta, char dir);