https://sourceforge.net/p/ansigl/wiki/SourceCode_0_0_Classes_Window/Recent changes to SourceCode_0_0_Classes_WindowenTue, 22 May 2012 22:09:14 -0000https://sourceforge.net/p/ansigl/wiki/SourceCode_0_0_Classes_Window/<pre>--- v3 +++ v4 @@ -4,18 +4,18 @@ Overview ---------------------------------------- -A Window is a [Surface-based](Classes_Surface) lineage designed around containing and presenting information (with titles, borders, scrollbars, etc.). The [Sprite-lineage](Classes_Sprite) is the tree for ANSI/ASCII-art images and other "meaningful content" usually displayed within a Window. +A Window is a [Surface-based](SourceCode_0_0_Classes_Surface) lineage designed around containing and presenting information (with titles, borders, scrollbars, etc.). The [Sprite-lineage](SourceCode_0_0_Classes_Sprite) is the tree for ANSI/ASCII-art images and other "meaningful content" usually displayed within a Window. Relationships ---------------------------------------- * Inheritance: * Parents: - * [Surface](Classes_Surface) + * [Surface](SourceCode_0_0_Classes_Surface) * Children: - * [TextWindow](Classes_TextWindow) + * [TextWindow](SourceCode_0_0_Classes_TextWindow) * Related: - * [WindowBorders](Classes_WindowBorders) + * [WindowBorders](SourceCode_0_0_Classes_WindowBorders) Member Variables </pre>NicroHobakTue, 22 May 2012 22:09:14 -0000https://sourceforge.netc49e003fb98b398b1b829259eb0b6cf0ade26a93https://sourceforge.net/p/ansigl/wiki/Classes_Window/<pre>--- v2 +++ v3 @@ -34,18 +34,15 @@ **Window Sizing** | Size() | Returns the total size of the window Resize() | Sets the total size of the window (borders and everything; everything is confined within this total area) -Width() | Gets the width of the entire window -SetWidth() | Sets the width of the entire window -Height() | Gets the height of the entire window -SetHeight() | Sets the height of the entire window +Width() | Gets/sets the width of the entire window +Height() | Gets/sets the height of the entire window **Content Functions** | TotalContentSize() | Returns an Area of the size of the entire logical content area VisibleContentSize() | Returns an Area of the size of the currently visible area (the viewport) -ContentPos() | Gets the position of the viewport -SetContentPos() | Sets the position of the viewport +ContentPos() | Gets/sets the position of the viewport MoveContentPos() | Adds to the current position of the viewport -HScroll() | Scrolls horizontally by number of lines, negative for left, positive for right -VScroll() | Scrolls vertically by number of lines, negative for left, positive for right +ScrollH() | Scrolls horizontally by number of lines, negative for left, positive for right +ScrollV() | Scrolls vertically by number of lines, negative for left, positive for right Title() | Sets the Window title **Borders** | *Title Border* | *These functions all operate on the title border* </pre>NicroHobakSat, 14 Jan 2012 18:45:19 -0000https://sourceforge.net56c49af392edec47de6e833c84d6301c3058e4eehttps://sourceforge.net/p/ansigl/wiki/Classes_Window/<pre>--- v1 +++ v2 @@ -23,41 +23,72 @@ Data Type | Name | Details ---------------------- | ---------- | ----------------------------------- -Point | Offset | - - +Point | Offset | An offset to add to the origin during rendering (an alternative way to think about it, is the Point on the Window to use as the origin when rendering) + + Member Functions ---------------------------------------- Name | Details ------------------------- | --------------------------------------------- -Size() | -Resize() | -Width() | -SetWidth() | -Height() | -SetHeight() | -TotalContentSize() | -VisibleContentSize() | -ContentPos() | -SetContentPos() | -MoveContentPos() | -HScroll() | -VScroll() | -Title() | -TitleBorderTop() | -TitleBorderLeft() | -TitleBorderRight() | -TItleBorderBottom() | -TitleBorderTopLeft() | -TitleBorderTopRight() | -TitleBorderBottomLeft() | -TitleBorderBottomRight() | -WinBorderTop() | -WinBorderLeft() | -WinBorderRight() | -WinBorderBottom() | -WinBorderTopLeft() | -WinBorderTopRight() | -WinBorderBottomLeft() | -WinBorderBottomRight() | +**Window Sizing** | +Size() | Returns the total size of the window +Resize() | Sets the total size of the window (borders and everything; everything is confined within this total area) +Width() | Gets the width of the entire window +SetWidth() | Sets the width of the entire window +Height() | Gets the height of the entire window +SetHeight() | Sets the height of the entire window +**Content Functions** | +TotalContentSize() | Returns an Area of the size of the entire logical content area +VisibleContentSize() | Returns an Area of the size of the currently visible area (the viewport) +ContentPos() | Gets the position of the viewport +SetContentPos() | Sets the position of the viewport +MoveContentPos() | Adds to the current position of the viewport +HScroll() | Scrolls horizontally by number of lines, negative for left, positive for right +VScroll() | Scrolls vertically by number of lines, negative for left, positive for right +Title() | Sets the Window title +**Borders** | +*Title Border* | *These functions all operate on the title border* +TitleBorderTop() | Gets/sets the top border character (or string) +TitleBorderLeft() | Gets/sets the left border character (or string) +TitleBorderRight() | Gets/sets the right border character (or string) +TItleBorderBottom() | Gets/sets the bottom border character (or string) +TitleBorderTopLeft() | Gets/sets the top-left corner character +TitleBorderTopRight() | Gets/sets the top-right corner character +TitleBorderBottomLeft() | Gets/sets the bottom-left corner character +TitleBorderBottomRight() | Gets/sets the bottom-right corner character +ClearTitleBorderTop() | Clears the top border (corners as well) +ClearTitleBorderLeft() | Clears the left border (corners as well) +ClearTitleBorderRight() | Clears the right border (corners as well) +ClearTitleBorderBottom() | Clears the bottom border (corners as well) +ClearTitleBorders() | Clears every border around the title +*Window Border* | *These functions all operate on the window border* +WinBorderTop() | Gets/sets the top border character (or string) +WinBorderLeft() | Gets/sets the left border character (or string) +WinBorderRight() | Gets/sets the right border character (or string) +WinBorderBottom() | Gets/sets the bottom border character (or string) +WinBorderTopLeft() | Gets/sets the top-left corner character +WinBorderTopRight() | Gets/sets the top-right corner character +WinBorderBottomLeft() | Gets/sets the bottom-left corner character +WinBorderBottomRight() | Gets/sets the bottom-right corner character +ClearWinBorderTop() | Clears the top border (corners as well) +ClearWinBorderLeft() | Clears the left border (corners as well) +ClearWinBorderRight() | Clears the right border (corners as well) +ClearWinBorderBottom() | Clears the bottom border (corners as well) +ClearWInBorders() | Clears every border around the title +*All Borders* | +ClearAllBorders() | Clears both the title and window borders +**Margins** | +LeftMargin() | Checks/sets if the left margin is visible +RightMargin() | Checks/sets if the left margin is visible +Margins() | Checks/sets both margins' visibility +**Scrollbars** | +ShowScrollbarTop() | Checks/sets if a horizontal scrollbar should be placed at the top of the viewport +ShowScrollbarLeft() | Checks/sets if a vertical scrollbar should be placed on the left of the viewport +ShowScrollbarRight() | Checks/sets if a vertical scrollbar should be placed on the right of the viewport +ShowScrollbarBottom() | Checks/sets if a horizontal scrollbar should be placed on the bottom of the viewport +HScrollbars() | Sets visibility for both horizontal scrollbars +VScrollbars() | Sets visibility both vertical scrollbars +Scrollbars() | Sets visibility for all scrollbars +HScrollbar() | Sets the horizontal scrollbar character +VScrollbar() | Sets the vertical scrollbar character </pre>NicroHobakSat, 14 Jan 2012 04:44:58 -0000https://sourceforge.net90ef13300efa4b5b822c6e5df8c8f42db3a60536https://sourceforge.net/p/ansigl/wiki/Classes_Window/Class: Window ======================================== Overview ---------------------------------------- A Window is a [Surface-based](Classes_Surface) lineage designed around containing and presenting information (with titles, borders, scrollbars, etc.). The [Sprite-lineage](Classes_Sprite) is the tree for ANSI/ASCII-art images and other "meaningful content" usually displayed within a Window. Relationships ---------------------------------------- * Inheritance: * Parents: * [Surface](Classes_Surface) * Children: * [TextWindow](Classes_TextWindow) * Related: * [WindowBorders](Classes_WindowBorders) Member Variables ---------------------------------------- Data Type | Name | Details ---------------------- | ---------- | ----------------------------------- Point | Offset | Member Functions ---------------------------------------- Name | Details ------------------------- | --------------------------------------------- Size() | Resize() | Width() | SetWidth() | Height() | SetHeight() | TotalContentSize() | VisibleContentSize() | ContentPos() | SetContentPos() | MoveContentPos() | HScroll() | VScroll() | Title() | TitleBorderTop() | TitleBorderLeft() | TitleBorderRight() | TItleBorderBottom() | TitleBorderTopLeft() | TitleBorderTopRight() | TitleBorderBottomLeft() | TitleBorderBottomRight() | WinBorderTop() | WinBorderLeft() | WinBorderRight() | WinBorderBottom() | WinBorderTopLeft() | WinBorderTopRight() | WinBorderBottomLeft() | WinBorderBottomRight() | NicroHobakSat, 14 Jan 2012 01:50:17 -0000https://sourceforge.net2fa8627d7db3a0cae6b060b9f7860e23362153c1