A GURPS Character Assistant v4 (GCA4) character print sheet.
Version: 1.37, requires GCA version 4.0.371 or greater.
See: http://www.motoslave.net/thom/gca/phoenix/
| Phoenix | A GURPS Character Assistant v4 (GCA4) character print sheet. |
| Notes | Edit this file ONLY as a last resort! |
| Constants: General | |
| Trait Type | |
| Spacing | |
| Character | |
| Color | |
| Font Style | |
| Pen Style (from VSPrinter) | |
| Brush Style (from VSPrinter) | |
| Text Align (from VSPrinter) | |
| Constants: List | All list constant flags MUST match the order of their associated lists. |
| Block Printing Control List | |
| Trait Folding Control List | |
| Additional Statistics List | |
| Wound/ | |
| Ancillary Statistics Block List | |
| Lifting Feats List | |
| Slam Table List | |
| Encumbrance Table List | |
| Descriptive Tags List | |
| Attack Source Hiding List | |
| Footnote Control List | |
| Trait Hiding List | |
| Separator List | |
| Sub-Separator List | |
| Constants: Attack Tables | |
| Attack Notes | |
| Globals | |
| Page/ | |
| Fonts | |
| Attack Tables | |
| Miscellaneous | |
| Quick View | |
| Functions: Main | |
| CharacterSheetOptions | Sheet options handler; called by GCA and so must exist. |
| SheetOptions_VersionCheck | Sheet options version checker and upgrader. |
| Main | Main event handler; called by GCA and so must exist. |
| Functions: Page One Header | |
| Static_PageOneHeader | Print the page one header. |
| Functions: Primary Statistics | |
| Static_PrimaryStats | Print the primary statistic block. |
| PrimaryStats_RenderItem | Render a statistic item. |
| Functions: Wound/ | |
| Block_WoundUsage | Print the wound/usage recording block. |
| WoundUsage_RenderRecordBlanks | Render the hit and fatigue points record blanks. |
| WoundUsage_RenderHPCheckboxes | Render the hit points checkboxes. |
| WoundUsage_RenderHPBreakpointsChart | Render the hit points breakpoints chart. |
| WoundUsage_RenderFPCheckboxes | Render the fatigue points checkboxes. |
| WoundUsage_RenderFPBreakpointsChart | Render the fatigue points breakpoints chart. |
| WoundUsage_RenderSPCheckboxes | Render the stress points checkboxes. |
| WoundUsage_RenderSPBreakpointsChart | Render the stress points breakpoints chart. |
| WoundUsage_RenderERCheckboxes | Render the energy reserve checkboxes. |
| WoundUsage_RenderPICheckboxes | Render the power item checkboxes. |
| Functions: Ancillary Statistic Blocks | |
| Block_AncillaryBlocks | Print the ancillary statistics blocks. |
| AncillaryBlocks_RenderTelekinesis | Render the telekinesis ancillary block. |
| AncillaryBlocks_RenderUMana | Render the “threshold limited magic”/”unlimited mana” ancillary block. |
| AncillaryBlocks_RenderMage | Render the Mage: The Ascension ancillary block. |
| Functions: Lifting Feats | |
| Block_LiftingFeats | Print the lifting feats block. |
| Functions: Slam Table | |
| Block_SlamTable | Print the slam table block. |
| Functions: Encumbrance Table | |
| Block_EncumbranceTable | Print the encumbrance table block. |
| Functions: Defenses | |
| Block_Defenses | Print the defenses block (active & passive). |
| Defenses_DamageResistances | Render the expanded damage resistances table sub-block. |
| Defenses_PaperDoll | Render the paper-doll sub-block. |
| Functions: Reaction Modifiers | |
| Block_ReactionModifiers | Print the reaction modifiers block. |
| Functions: Cultural Familiarities | |
| Block_CulturalList | Print the cultural familiarity block. |
| CulturalList_RenderItem | Render the passed cultural familiarity trait object. |
| CulturalList_IsPrintable | Test if the passed trait object is a cultural familiarity and should be printed. |
| CulturalList_IsNative | Test if the passed trait object is a native cultural familiarity. |
| Functions: Languages | |
| Block_LanguageList | Print the language block. |
| LanguageList_RenderItem | Render the passed language trait object. |
| LanguageList_IsPrintable | Test if the passed trait object is a language and should be printed. |
| LanguageList_IsNative | Test if the passed trait object is a native language. |
| Functions: Advantage-Type Blocks | |
| Block_AdList | Print the templates and meta-traits, ads, perks, disads, and quirks blocks. |
| AdList_RenderItem | Render the passed advantage-type trait object. |
| AdList_IsPrintable | Test if the passed trait object is an advantage-type trait and should be printed. |
| Functions: Skill-Type Blocks | |
| Block_SkillList | Print the skills, techniques, ritual magic paths, and spells blocks. |
| SkillList_RenderItem | Render the passed skill-type trait object. |
| SkillList_IsPrintable | Test if the passed trait object is an skill-type trait and should be printed. |
| Functions: Combat Charts | |
| Block_SizeSpeedRangeTable | Print the size and speed/range table block. |
| Block_HumanoidHitLocationTable | Print the humanoid hit location table block. |
| Functions: Attacks Tables | |
| CreateAttackLists | Create the melee & ranged attack lists. |
| Block_MeleeAttackList | Print the melee attack table block. |
| MeleeAttackList_RenderItem | Render the passed melee attack mode trait object. |
| MeleeAttackList_IsPrintable | Test if the passed trait object contains melee attack modes and should be printed. |
| Block_RangedAttackList | Print the ranged attack table block. |
| RangedAttackList_RenderItem | Render the passed ranged attack mode trait object. |
| RangedAttackList_IsPrintable | Test if the passed trait object contains ranged attack modes and should be printed. |
| AttackList_RenderFieldNotesChart | Render the attack field notes chart. |
| Functions: Spell Grimoire | |
| Block_GrimoireList | Print the spell grimoire block. |
| GrimoireList_RenderItem | Render the passed spell trait object. |
| GrimoireList_IsPrintable | Test if the passed trait object is a spell and should be printed. |
| GrimoireList_FilterCats | Filter non-colleges from the passed spell category string. |
| Functions: Equipment/ | |
| Block_EquipmentList | Print the equipment block. |
| Block_LoadOutList | Print the load-out block. |
| EquipmentList_RenderItem | Render the passed equipment item trait object. |
| EquipmentList_IsPrintable | Test if the passed trait object is an equipment item and should be printed. |
| Functions: Campaign Log | |
| Block_CampaignLog | Print the campaign log block. |
| CampaignLog_RenderEntry | Render the passed campaign log entry object. |
| Functions: Points Summary | |
| Block_PointSummary | Print the points summary block. |
| Functions: Portrait, Description, & Notes | |
| Block_Portrait | Print the character portrait block. |
| Block_Description | Print the character description block. |
| Block_Notes | Print the character notes block. |
| Static_PortraitDescAndNotes | Print the character portrait, description, and notes at the end of the sheet. |
| DescOrNotesOverflowsColumn | Test if the character description and/or notes exceed one column in length. |
| DescOverflowsColumn | Test if the character description exceeds one column in length. |
| NotesOverflowsColumn | Test if the character notes exceed one column in length. |
| Functions: Scratch Pad | |
| Block_ScratchPad | Print the scratch pad block. |
| Functions: Utility - Footnotes | |
| ResetFootnotes | Reset/clear the current footnotes. |
| RenderFootnotes | Render the current footnotes. |
| CalcFootnotesHeight | Calculate the minimum height of the current footnotes based on printing within 1-3 sub-columns. |
| SetFootnote | Set the passed text as a footnote and return its symbol. |
| GetFootnote | Register an aggregate of all bonus and conditional footnotes for the passed trait object and block flag as a footnote and return the symbol. |
| GetFootnoteText | Aggregate and return all bonus and conditional footnotes for the passed trait object and block flag. |
| Functions: Utility - Trait & Tag | |
| FetchTraitByNameAndExt | Fetch a trait item object reference to the passed trait fullname and type. |
| FetchTraitByNameOnly | Fetch a trait item object reference to the passed trait name and type. |
| FetchTraitBySymbol | Fetch a trait item object reference to the passed trait symbol and type. |
| GetTraitTagValue | Get the value of the passed tag name from the passed trait fullname and type. |
| GetRelativeTrait | Get the relative-trait-score string from the passed relative-trait string and score. |
| Functions: Utility - Sheet Initialization | |
| PageSetup | Initialize the page settings. |
| FontSetup | Initialize the font settings. |
| DrawSetup | Initialize the drawing settings (pen & brush values). |
| Functions: Utility - Page & Column Positioning | |
| NotEnoughSpace | Test to see if the passed height will not fit within the space available to the current column. |
| SetColumnUsage | Set column usage; one column or both together (whole page). |
| SwitchToColumn | Set the currently active column. |
| ToggleColumn | Toggle the active column. |
| UpdateColumnTops | Update the top of the currently active column. |
| SetColumnTop | Set the top Y-coordinate of the currently active column. |
| SetColumnBottom | Set the bottom Y-coordinate of the currently active column. |
| AdvanceToNextColumn | Advance to the next column, starting a new page if necessary. |
| StartNewPage | Start a new page. |
| Functions: Utility - Header & Footer Settings | |
| SetHeaderFont | Initialize the header and footer font settings. |
| SetHeader | Set the page/sheet header. |
| SetFooter | Set the page/sheet footer. |
| Functions: Utility - Fonts | |
| SetFont | Set the font settings (name, size, color, bold, italic, underline). |
| CalcFontSize | Calculate largest font size that will allow the passed text to fit within the passed dimensions. |
| Functions: Utility - Text Height & Width Calculation | |
| RealTextHeight | Calculate the height of the passed text based on the passed width and current font settings. |
| CalcHeightEx | Calculate the height of the passed text based on the passed font settings and passed width. |
| CalcHeight | Calculate the height of the passed text based on the passed font settings and passed width. |
| CalcWidthEx | Calculate the width of the passed text based on the passed font settings. |
| CalcWidth | Calculate the width of the passed text based on the passed font settings. |
| Functions: Utility - Tests | |
| IsSkipped | Test if the passed trait object MUST be skipped. |
| IsHidden | Test if the passed trait object should be hidden. |
| IsLocked | Test if the passed trait object is locked. |
| StatExists | Test if the passed statistc exists. |
| StatNotEmpty | Test if the passed statistc exists and has a non-zero value. |
| OptionFlagSet | Test if the passed bit-flags are set within the bit-field contained within the passed option name. |
| IsFlagSet | Test if the passed bit-flags are set within the passed bit-field. |
| IsNA | Test if the passed value should be considered a “not applicable/available” value. |
| Functions: Utility - Math | |
| RoundGreater | Round the passed number to the next integer of greater magnitude. |
| RoundLesser | Round the passed number to the next integer of lesser magnitude. |
| Ceil | Round the passed number to the next larger integer. |
| Floor | Round the passed number to the next smaller integer. |
| NumToSci | Convert the passed number to a normalized scientific “e” notation string. |
| SciToNum | Convert the passed scientific “e” notation string to a number. |
| Max | Determine which of the passed numbers is the largest. |
| Min | Determine which of the passed numbers is the smallest. |
| Avg | Calculate the average (arithmetic mean) of the passed numbers. |
| MaxList | Determine which of the numbers within the passed array is the largest. |
| MinList | Determine which of the numbers within the passed array is the smallest. |
| AvgList | Calculate the average (arithmetic mean) of the numbers within the passed array. |
| Functions: Utility - Math, GURPS | |
| RoundGURPSThreshOver | Round the passed number to the GURPS “over” threshold. |
| RoundGURPSThreshUnder | Round the passed number to the GURPS “under” threshold. |
| Functions: Utility - Type Conversion | |
| StrToDbl | Convert the passed simple numeric string, from virtually any locale, to a double. |
| StrToLng | Convert the passed simple numeric string, from virtually any locale, to a long. |
| Functions: Utility - Dice | |
| DiceAccumulator | Accumulate the dice within the passed array. |
| Functions: Utility - Text Manipulation | |
| Chomp | Trim line termination from the end of the passed string. |
| UCFirst | Uppercase the first character of the passed string. |
| UCWords | Uppercase the first character of every word in the passed string. |
| Functions: Utility - Measurement Manipulation | |
| GetEquipMass | Convert an equipment mass measurement to the appropriate scaled unit-type. |
| GetEquipMassUnit | Convert an equipment mass measurement to the appropriate scaled unit. |
| GetScaledUnit | Convert a measurement to the appropriate scaled unit. |
| GetScaledMassUnit | Convert a mass measurement, from an assumed unit-type, to the appropriate scaled unit. |
| GetScaledLengthUnit | Convert a distance/length measurement, from an assumed or integral unit-type, to the appropriate scaled unit. |
| AbbreviateLengthUnit | Convert a distance/length unit to its normalized abbreviated form. |
| Functions: Utility - RTF Creation | |
| IsTextRTF | Test if the passed string could be an RTF document or fragment. |
| CreateRtfDoc | Creates and returns an RTF document from the passed font name list, color list, and RTF fragment. |
| CreateRtfFontTbl | Creates and returns an RTF font table from the passed font name list. |
| CreateRtfColorTbl | Creates and returns an RTF color table from the passed color list. |
| GetRtfFont | Get an RTF font setting command for the passed font. |
| Functions: Utility - Printing | |
| TextBoxEx | Print the passed text, making necessary adjustments if it is RTF. |
| Functions: Utility - Drawing | |
| DrawImage | Render an image centered within the passed area, scaled if necessary. |
| DrawRectangleEx | Render a rectangle at the passed coordinates. |
| DrawShade | Render a shaded rectangle at the passed coordinates. |
| DrawBorder | Render a bounding rectangle at the passed coordinates. |
| DrawLineEx | Render a line at the passed coordinates. |
| DrawHRuleEx | Render a horizontal rule/line at the passed coordinates. |
| DrawHRule | Render a horizontal rule/line at the passed coordinates, with a solid pen. |
| DrawVRuleEx | Render a vertical rule/line at the passed coordinates. |
| DrawVRule | Render a vertical rule/line at the passed coordinates, with a solid pen. |
| Functions: Utility - Color Manipulation | |
| MixColors | Mix two colors. |
| Functions: Utility - Logging & Messaging | |
| LogMesg | Write a branded message to the log, except when in Quick View mode. |
| LogWarn | Write a branded warning message to the log. |
| LogFail | Write a branded failure/error message to the log. |
| PopFail | Pop-up a branded failure/error message dialog box. |
| PopYesNo | Pop-up a branded yes/no query dialog box. |
| Functions: Utility - Quick View | |
| Quick View Field Type Constants | |
| QV_AddTraitSelectButtons | Add the trait selection window buttons to the left margin of the current page. |
| QV_EditBar | Add an edit bar. |
| QV_TextBox | Add a text box. |
| QV_TextBox | Add a multi-line text box. |
| QV_TextBox | Add a trait selection window button. |
| QV_AddEditControlInTwips | Add an (interactive) editing control, specifying the coordinates and width in twips. |
| QV_DrawEditHotspotInTwips | Draw a shade rectangle, specifying the coordinates and width in twips. |
| Classes | |
| Vector | A fast, easy-to-use, dynamic array class |
| Pseudo-Constants | |
| c_Version | Class version string. |
| c_BaseAllocSize | Default base allocation size. |
| Private Properties | |
| pArray | Vector array. |
| pCount | Element count. |
| pCapacity | Total number of available elements. |
| pBaseAlloc | Base allocation size. |
| Private Methods | |
| Class_Initialize | Prepares the object for use. |
| Class_Terminate | Prepares the object for destruction. |
| pQSort | Sorts elements within a range. |
| pQSortCmpAsc | Ascending comparator for pQSort. |
| pQSortCmpDesc | Descending comparator for pQSort. |
| Public Properties | |
| Reserve (Accessor) | Get the base allocation size. |
| Reserve (Mutator) | Set the base allocation size. |
| Capacity (Accessor) | Get the current number of elements that the vector can hold without needing to allocate more storage. |
| Empty (Accessor) | Test if the vector is empty. |
| Count (Accessor) | Get the count of all elements. |
| LBound (Accessor) | Get the index of the first element. |
| UBound (Accessor) | Get the index of the last element. |
| AsArray (Accessor) | Get an array containing the values of all elements. |
| Item (Accessor) | Get the value of the element at the passed index. |
| Item (Mutator) | Assign the passed value to the element at the passed index. |
| First (Accessor) | Get the value of the first element. |
| First (Mutator) | Assign the passed value to the first element. |
| Last (Accessor) | Get the value of the last element. |
| Last (Mutator) | Assign the passed value to the last element. |
| Insert (Mutator) | Insert the passed value as a new element at the passed index. |
| Prepend (Mutator) | Add a new element to the beginning of the vector and assign it the passed value. |
| Append (Mutator) | Add a new element to the end of the vector and assign it the passed value. |
| Push (Mutator) | Add a new element to the end of the vector and assign it the passed value. |
| Pop (Mutator) | Delete the last element and return its value. |
| Enqueue (Mutator) | Add a new element to the end of the vector and assign it the passed value. |
| Dequeue (Mutator) | Delete the first element and return its value. |
| Public Methods | |
| Join | Return a string containing the values of all elements joined by the passed delimiter. |
| Find | Search for the passed value among the elements. |
| Contains | Test for the presence of the passed value among the elements. |
| Sort | Sorts all elements in ascending order. |
| SortRev | Sorts all elements in descending order. |
| Clear | Deletes all elements and resets the vector to the current base allocation size. |
| Delete | Delete the element at the passed index and return its value. |
| Checkbox | A checkbox rendering class |
| Pseudo-Constants | |
| c_Version | Class version string. |
| Private Properties | |
| pBreakPoints | Breakpoints vector. |
| pShowValues | Show values state. |
| pBaseBorderColor | Base border color. |
| pBaseFont | Base font for values. |
| pBaseFontColor | Base font color for values. |
| pBaseFontSize | Base font size for values. |
| pMaxFontSize | Maximum font size for values. |
| pMinFontSize | Minimum font size for values. |
| pStartValue | Starting value. |
| pStopValue | Stopping value. |
| pGroupCount | Number of groups. |
| pGroupSize | Number of checkboxes per group. |
| pBoxSpace | Horizontal space between boxes, within a group (inches). |
| pColumnSpace | Horizontal (column) space between groups (inches). |
| pRowSpace | Vertical (row) space between groups (inches). |
| pLeft | Left X-coordinate (inches). |
| pTop | Top Y-coordinate (inches). |
| pWidth | Width (inches). |
| Private Properties (internal use) | |
| pTotalHeight | Calculated height. |
| pGroupWidth | Width of a group of boxes (inches). |
| pBoxWidth | Width of each box (inches). |
| Private Methods | |
| Class_Initialize | Prepares the object for use. |
| Class_Terminate | Prepares the object for destruction. |
| Public Properties | |
| Left (Accessor) | Get the left X-coordinate. |
| Left (Mutator) | Set the left X-coordinate. |
| Top (Accessor) | Get the top Y-coordinate. |
| Top (Mutator) | Set the top Y-coordinate. |
| Width (Accessor) | Get the width dimension. |
| Width (Mutator) | Set the width dimension. |
| ShowValues (Accessor) | Get the show values state. |
| ShowValues (Mutator) | Set the show values state. |
| BaseBorderColor (Accessor) | Get the base border color. |
| BaseBorderColor (Mutator) | Set the base border color. |
| BaseFont (Accessor) | Get the base font for checkbox values. |
| BaseFont (Mutator) | Set the base font for checkbox values. |
| BaseFontColor (Accessor) | Get the base font color for checkbox values. |
| BaseFontColor (Mutator) | Set the base font color for checkbox values. |
| BaseFontSize (Accessor) | Get the base font size for checkbox values. |
| BaseFontSize (Mutator) | Set the base font size for checkbox values. |
| MaxFontSize (Accessor) | Get the maximum font size for checkbox values. |
| MaxFontSize (Mutator) | Set the maximum font size for checkbox values. |
| MinFontSize (Accessor) | Get the minimum font size for checkbox values. |
| MinFontSize (Mutator) | Set the minimum font size for checkbox values. |
| StartValue (Accessor) | Get the beginning value. |
| StartValue (Mutator) | Set the beginning value. |
| StopValue (Accessor) | Get the ending value. |
| StopValue (Mutator) | Set the ending value. |
| GroupCount (Accessor) | Get the checkbox group count. |
| GroupCount (Mutator) | Set the checkbox group count. |
| GroupSize (Accessor) | Get the checkbox group size. |
| GroupSize (Mutator) | Set the checkbox group size. |
| BoxSpace (Accessor) | Get the checkbox spacer size. |
| BoxSpace (Mutator) | Set the checkbox spacer size. |
| ColumnSpace (Accessor) | Get the checkbox group horizontal (column) spacer size. |
| ColumnSpace (Mutator) | Set the checkbox group horizontal (column) spacer size. |
| RowSpace (Accessor) | Get the checkbox group vertical (row) spacer size. |
| RowSpace (Mutator) | Set the checkbox group vertical (row) spacer size. |
| Public Methods | |
| Clear | Deletes all breakpoints and reinitializes the object to default settings. |
| AddBreakpointEx | Add a breakpoint. |
| AddBreakpoint | Add a breakpoint. |
| ClearBreakpoints | Deletes all breakpoints. |
| CalcHeight | Calculate the height required to render the checkboxes based on the current settings. |
| RenderCheckboxes | Renders the checkboxes. |
Sub CharacterSheetOptions()
Sheet options handler; called by GCA and so must exist. Called by GCA to initialize the Options object for this sheet, either to setup the Sheet Options Window or prior to a call to Main.
Sub SheetOptions_VersionCheck()
Sheet options version checker and upgrader. Called by CharacterSheetOptions to check the stored sheet options version and, if necessary, upgrade those options to what is correct for this sheet version.
Sub PrimaryStats_RenderItem( ByVal aStat, ByVal aLeft, ByVal aRight, ByVal aHeight, ByVal aShowCost, ByVal aShade )
Render a statistic item.
| aStat | [String] The name of the statistic to print. |
| aLeft | [Double] Left bound of the print area (inches). |
| aRight | [Double] Right bound of the print area (inches). |
| aHeight | [Double] Height of the print area (inches). |
| aShowCost | [Boolean] Whether to show the statistic’s point cost. |
| aShade | [Boolean] Whether to shade the print area. |
Function WoundUsage_RenderHPBreakpointsChart( ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aCalc )
Render the hit points breakpoints chart.
| aLeft | [Double] Left bound of the print area (inches). |
| aTop | [Double] Top bound of the print area (inches). |
| aWidth | [Double] Width of the print area (inches). |
| aCalc | [Boolean] Whether the height required to print the block should be calculated and returned in lieu of printing the block. |
[Integer] If aCalc is true, the height of the block (inches).
Function WoundUsage_RenderFPBreakpointsChart( ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aCalc )
Render the fatigue points breakpoints chart.
| aLeft | [Double] Left bound of the print area (inches). |
| aTop | [Double] Top bound of the print area (inches). |
| aWidth | [Double] Width of the print area (inches). |
| aCalc | [Boolean] Whether the height required to print the block should be calculated and returned in lieu of printing the block. |
[Integer] If aCalc is true, the height of the block (inches).
Function WoundUsage_RenderSPBreakpointsChart( ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aCalc )
Render the stress points breakpoints chart.
| aLeft | [Double] Left bound of the print area (inches). |
| aTop | [Double] Top bound of the print area (inches). |
| aWidth | [Double] Width of the print area (inches). |
| aCalc | [Boolean] Whether the height required to print the block should be calculated and returned in lieu of printing the block. |
[Integer] If aCalc is true, the height of the block (inches).
Sub CulturalList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Render the passed cultural familiarity trait object.
| arTrait | [Object] A trait item object. |
| aIndent | [Double] Indention to use (inches). Used recursively, it should be passed zero (0) under normal usage. |
| aParent | [Object] Trait item object of the parent trait. Used recursively, it should be passed Empty under normal usage. |
| aHeader | [Integer] Header printing state. |
| aLabel | [String] Label used for the “name” column. |
Sub LanguageList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Render the passed language trait object.
| arTrait | [Object] A trait item object. |
| aIndent | [Double] Indention to use (inches). Used recursively, it should be passed zero (0) under normal usage. |
| aParent | [Object] Trait item object of the parent trait. Used recursively, it should be passed Empty under normal usage. |
| aHeader | [Integer] Header printing state. |
| aLabel | [String] Label used for the “name” column. |
Sub Block_AdList( ByVal aType, ByVal aBlanks )
Print the templates and meta-traits, ads, perks, disads, and quirks blocks.
| aType | [Integer] Trait Type denoting which block to print. |
| aBlanks | [Integer] Number of blank lines to append to the normal output of the block. |
Sub AdList_RenderItem( ByRef arTrait, ByVal aType, ByVal aIndent, ByVal aParent, ByVal aHeader )
Render the passed advantage-type trait object.
| arTrait | [Object] A trait item object. |
| aType | [Integer] Trait Type of the trait; can only be of type gcaTemplate, gcaAd, gcaPerk, gcaDisad, or gcaQuirk. |
| aIndent | [Double] Indention to use (inches). Used recursively, it should be passed zero (0) under normal usage. |
| aParent | [Object] Trait item object of the parent trait. Used recursively, it should be passed Empty under normal usage. |
| aHeader | [Integer] Header printing state. |
Function AdList_IsPrintable( ByRef arTrait, ByVal aType, ByVal aIsChild )
Test if the passed trait object is an advantage-type trait and should be printed.
| arTrait | [Object] A trait item object. |
| aType | [Integer] Trait Type of the block; can only be of type gcaTemplate, gcaAd, gcaPerk, gcaDisad, or gcaQuirk. |
| aIsChild | [Boolean] Is the trait item object a child. |
[Boolean] Whether the passed trait object is an advantage-type trait and should be printed.
Sub Block_SkillList( ByVal aType, ByVal aBlanks )
Print the skills, techniques, ritual magic paths, and spells blocks.
| aType | [Integer] Trait Type denoting which block to print. |
| aBlanks | [Integer] Number of blank lines to append to the normal output of the block. |
Sub SkillList_RenderItem( ByRef arTrait, ByVal aType, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Render the passed skill-type trait object.
| arTrait | [Object] A trait item object. |
| aType | [Integer] Trait Type of the trait; can only be of type gcaSkill, gcaSkillTech, gcaSkillPath, or gcaSpell. |
| aIndent | [Double] Indention to use (inches). Used recursively, it should be passed zero (0) under normal usage. |
| aParent | [Object] Trait item object of the parent trait. Used recursively, it should be passed Empty under normal usage. |
| aHeader | [Integer] Header printing state. |
| aLabel | [String] Label used for the “name” column. |
Function SkillList_IsPrintable( ByRef arTrait, ByVal aType, ByVal aIsChild )
Test if the passed trait object is an skill-type trait and should be printed.
| arTrait | [Object] A trait item object. |
| aType | [Integer] Trait Type of the block; can only be of type gcaSkill, gcaSkillTech, gcaSkillPath, or gcaSpell. |
| aIsChild | [Boolean] Is the trait item object a child. |
[Boolean] Whether the passed trait object is a skill-type trait and should be printed.
Sub MeleeAttackList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Render the passed melee attack mode trait object.
| arTrait | [Object] A trait item object. |
| aIndent | [Double] Indention to use (inches). Used recursively, it should be passed zero (0) under normal usage. |
| aParent | [Object] Trait item object of the parent trait. Used recursively, it should be passed Empty under normal usage. |
| aHeader | [Integer] Header printing state. |
| aLabel | [String] Label used for the “name” column. |
Function MeleeAttackList_IsPrintable( ByRef arTrait )
Test if the passed trait object contains melee attack modes and should be printed.
| arTrait | [Object] A trait item object. |
[Boolean] Whether the passed trait object contains melee attack modes and should be printed.
Sub RangedAttackList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Render the passed ranged attack mode trait object.
| arTrait | [Object] A trait item object. |
| aIndent | [Double] Indention to use (inches). Used recursively, it should be passed zero (0) under normal usage. |
| aParent | [Object] Trait item object of the parent trait. Used recursively, it should be passed Empty under normal usage. |
| aHeader | [Integer] Header printing state. |
| aLabel | [String] Label used for the “name” column. |
Function RangedAttackList_IsPrintable( ByRef arTrait )
Test if the passed trait object contains ranged attack modes and should be printed.
| arTrait | [Object] A trait item object. |
[Boolean] Whether the passed trait object contains ranged attack modes and should be printed.
Function AttackList_RenderFieldNotesChart( ByVal aCalc )
Render the attack field notes chart.
| aCalc | [Boolean] Whether the height required to print the block should be calculated and returned in lieu of printing the block. |
[Integer] If aCalc is true, the height of the block (inches).
Function EquipmentList_RenderItem( ByRef arTrait, ByVal aType, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel, ByVal aIsPKid )
Render the passed equipment item trait object.
| arTrait | [Object] A trait item object. |
| aType | [Integer] Trait Type of the trait; can only be of type gcaEquip or gcaEquipLoad. |
| aIndent | [Double] Indention to use (inches). Used recursively, it should be passed zero (0) under normal usage. |
| aParent | [Object] Trait item object of the parent trait. Used recursively, it should be passed Empty under normal usage. |
| aHeader | [Integer] Header printing state. |
| aLabel | [String] Label used for the “name” column. |
| aIsPKid | [Boolean] Is the trait item object a package kid. Used recursively, it should be passed False under normal usage. |
[Array] The total cost and weight of the passed trait object, including descendant traits (children and kids).
Function EquipmentList_IsPrintable( ByRef arTrait, ByVal aType )
Test if the passed trait object is an equipment item and should be printed.
| arTrait | [Object] A trait item object. |
| aType | [Integer] Trait Type of the trait. Can only be of type gcaEquip or gcaEquipLoad. |
[Boolean] Whether the passed trait object is an equipment item and should be printed.
Function CalcFootnotesHeight()
Calculate the minimum height of the current footnotes based on printing within 1-3 sub-columns. Also, store both pieces of information (minimum height and the associated number of sub-columns) in the FootnotesHeight and FootnotesCols globals (see: Miscellaneous globals).
[Double] The minimum height required to render the footnotes.
Function GetFootnote( ByRef arTrait, ByVal aBlock )
Register an aggregate of all bonus and conditional footnotes for the passed trait object and block flag as a footnote and return the symbol.
| arTrait | [Object] A trait item object. |
| aBlock | [Integer] Flag representing the block for which to attempt the operation. |
[String] The symbol assocaited with the aggregate footnote for the passed trait object, on success, or an empty string, on failure.
Function GetFootnoteText( ByRef arTrait, ByVal aBlock )
Aggregate and return all bonus and conditional footnotes for the passed trait object and block flag.
| arTrait | [Object] A trait item object. |
| aBlock | [Integer] Flag representing the block for which to attempt the operation. |
[String] The aggregate of all bonus and conditional footnotes for the passed trait object, on success, or an empty string, on failure.
Function FetchTraitByNameAndExt( ByRef arTrait, ByVal aFullName, ByVal aType )
Fetch a trait item object reference to the passed trait fullname and type.
For more info on trait item objects, see: http://www.misersoft.com
| arTrait | [Variant] A storage variable, which will contain, post-call, a reference to the trait item object, on success, or Null, on failure. |
| aFullName | [String] Fullname (name & extension) of the trait. |
| aType | [Integer] Trait Type of the trait. |
[Boolean] The status of the operation.
Function FetchTraitByNameOnly( ByRef arTrait, ByVal aName, ByVal aType )
Fetch a trait item object reference to the passed trait name and type.
For more info on trait item objects, see: http://www.misersoft.com
| arTrait | [Variant] A storage variable, which will contain, post-call, a reference to the trait item object, on success, or Null, on failure. |
| aName | [String] Name (only) of the trait. |
| aType | [Integer] Trait Type of the trait. |
[Boolean] The status of the operation.
Function FetchTraitBySymbol( ByRef arTrait, ByVal aSymbol, ByVal aType )
Fetch a trait item object reference to the passed trait symbol and type.
For more info on trait item objects, see: http://www.misersoft.com
| arTrait | [Variant] A storage variable, which will contain, post-call, a reference to the trait item object, on success, or Null, on failure. |
| aSymbol | [String] Symbol of the trait. |
| aType | [Integer] Trait Type of the trait. |
[Boolean] The status of the operation.
Function GetTraitTagValue( ByVal aFullName, ByVal aTag, ByVal aType )
Get the value of the passed tag name from the passed trait fullname and type.
| aTag | [String] Name of the tag. |
| aFullName | [String] Fullname (name & extension) of the trait. |
| aType | [Integer] Trait Type of the trait. |
[Variant] The value of the requested tag, on success, or Empty, on failure.
Function GetRelativeTrait( ByVal aTrait, ByVal aScore )
Get the relative-trait-score string from the passed relative-trait string and score.
| aTrait | [String] Relative-trait string. Generally, in the format ”type:name”[(+|-)value] and pulled from the tag “charskillused”. |
| aScore | [Integer] Current effective trait score. |
[String] The relative-trait-score string, on success, or an empty string, on failure.
Function NotEnoughSpace( ByVal aHeight )
Test to see if the passed height will not fit within the space available to the current column.
| aHeight | [Double] Height to test (inches). |
[Boolean] Whether the passed height will not fit within the space available to the current column.
Function CalcFontSize( ByVal aText, ByVal aFont, ByVal aSize, ByVal aWidth, ByVal aHeight )
Calculate largest font size that will allow the passed text to fit within the passed dimensions.
| aText | [String] Text to calculate upon. |
| aFont | [Integer] Font setting. |
| aSize | [Number] Font size (points). If set to zero, the default size for the chosen font is used. |
| aWidth | [Double] Width of the testing area (inches). If set to zero, width calculations are disabled. |
| aHeight | [Double] Height of the testing area (inches). If set to zero, height calculations are disabled. |
[Double] Font size (points).
Function RealTextHeight( ByVal aText, ByVal aWidth )
Calculate the height of the passed text based on the passed width and current font settings.
| aText | [String] Text whose height needs calculating. |
| aWidth | [Double] Width of the testing area (inches). If set to zero, the full usable page width is used. |
[Double] Height of the text (inches).
This function exists because TextHeight;
The first two issues are cause enough to not rely solely on TextHeight, however, the last issue is cause to never use TextHeight under any circumstances, so we have to use a combination of TextBox and TextHei.
Function CalcHeightEx( ByVal aText, ByVal aFont, ByVal aSize, ByVal aWidth )
Calculate the height of the passed text based on the passed font settings and passed width.
| aText | [String] Text whose width needs calculating. |
| aFont | [Integer] Font setting. |
| aSize | [Number] Font size (points). If set to zero, the default size for the chosen font is used. |
| aWidth | [Double] Width of the testing area (inches). If set to zero, the full usable page width is used. |
[Double] Height of the text (inches).
Function CalcHeight( ByVal aText, ByVal aFont, ByVal aWidth )
Calculate the height of the passed text based on the passed font settings and passed width.
| aText | [String] Text whose width needs calculating. |
| aFont | [Integer] Font setting. |
| aWidth | [Double] Width of the testing area (inches). If set to zero, the full usable page width is used. |
[Double] Height of the text (inches).
Function CalcWidthEx( ByVal aText, ByVal aFont, ByVal aSize )
Calculate the width of the passed text based on the passed font settings.
| aText | [String] Text whose width needs calculating. |
| aFont | [Integer] Font setting. |
| aSize | [Number] Font size (points). If set to zero, the default size for the chosen font is used. |
[Double] Width of the text (inches).
Function OptionFlagSet( ByVal aOption, ByVal aFlags )
Test if the passed bit-flags are set within the bit-field contained within the passed option name.
| aOption | [String] Name of an option value which is a bit-field to test against. |
| aFlags | [Integer] Flags to test. |
[Boolean] Whether the passed bit-flags are set within the bit-field of the passed option name.
Function IsNA( ByVal aText )
Test if the passed value should be considered a “not applicable/available” value. This function exists because people can’t seem to follow one standard way of representing “not applicable/available” when writing GDFs.
| aText | [String] String to test. |
[Boolean] Whether the passed value is “not applicable/available”.
Function NumToSci( ByVal aNum, ByVal aSigDigits )
Convert the passed number to a normalized scientific “e” notation string.
| aNum | [Number] Number to convert. |
| aSigDigits | [Number] Number indicating how many decimal places to round off at. |
[String] The string representation of the number in normalized scientific “e” notation.
Function StrToDbl( ByVal aNumStr )
Convert the passed simple numeric string, from virtually any locale, to a double.
CAVEAT: This function assumes that the values passed into it will not be be seriously malformed, values which are will likely cause lossage. Particularly, passed values MUST NOT contain digit grouping characters.
| aNumStr | [String] Numeric string to convert. |
[Double] The resultant double, on success, or zero, on failure.
Function StrToLng( ByVal aNumStr )
Convert the passed simple numeric string, from virtually any locale, to a long.
CAVEAT: This function assumes that the values passed into it will not be seriously malformed, values which are will likely cause lossage. Particularly, passed values MUST NOT contain a radix point.
| aNumStr | [String] Numeric string to convert. |
[Integer] The resultant long, on success, or zero, on failure.
Function GetEquipMass( ByVal aMeasure, ByVal aUnit )
Convert an equipment mass measurement to the appropriate scaled unit-type.
| aMeasure | [Variant] Measurement to convert. |
| aUnit | [String] Unit string for the measurement. Generally, from the tag “units”. |
[Double] The equipment mass measurement measurement.
Function GetEquipMassUnit( ByVal aMeasure, ByVal aUnit )
Convert an equipment mass measurement to the appropriate scaled unit.
| aMeasure | [Variant] Measurement to convert. |
| aUnit | [String] Unit string for the measurement. Generally, from the tag “units”. |
[String] The converted equipment mass measurement and unit.
Function GetScaledMassUnit( ByVal aMeasure )
Convert a mass measurement, from an assumed unit-type, to the appropriate scaled unit.
| aMeasure | [Variant] Measurement to convert. Measurement must be a numeric in either pounds or kilograms. |
[String] The converted mass measurement and unit.
Function GetScaledLengthUnit( ByVal aMeasure )
Convert a distance/length measurement, from an assumed or integral unit-type, to the appropriate scaled unit.
| aMeasure | [Variant] Measurement to convert. Measurement must be either a numeric in yards or include its unit (e.g. “8 ft”, “1.6 km”, etc). |
[String] The converted distance/length measurement and unit.
Function CreateRtfDoc( ByVal aFonts(), ByVal aColors(), ByVal aText )
Creates and returns an RTF document from the passed font name list, color list, and RTF fragment.
| aFonts() | [Array] Font name list. |
| aColors() | [Array] Color list. |
| aText | [String] RTF fragment. |
[String] The RTF document.
Sub TextBoxEx( ByVal aText, ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aHeight, ByVal aWrap )
Print the passed text, making necessary adjustments if it is RTF.
| aText | [String] Text to print. |
| aLeft | [Double] Left bound of the print area (inches). |
| aTop | [Double] Top bound of the print area (inches). |
| aWidth | [Double] Width of the print area (inches). |
| aHeight | [Double] Height of the print area (inches). |
| aWrap | [Boolean] Whether text that exceeds the width of the print area should be wrapped. |
Sub DrawImage( ByVal aImage, ByVal aX, ByVal aY, ByVal aW, ByVal aH, ByVal aUpscale )
Render an image centered within the passed area, scaled if necessary.
| aImage | [String] Path to the image. |
| aX | [Double] Left side of the print area (inches). |
| aY | [Double] Top side of the print area (inches). |
| aW | [Double] Width of the print area (inches). |
| aH | [Double] Height of the print area (inches). |
| aUpscale | [Boolean] Whether the image should be scaled up if both of its dimensions are less than the printable area. |
Sub DrawRectangleEx( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aR1, ByVal aR2, ByVal aPWidth, ByVal aPStyle, ByVal aPColor, ByVal aBStyle, ByVal aBColor )
Render a rectangle at the passed coordinates.
| aX1 | [Double] Left side of the print area (inches). |
| aY1 | [Double] Top side of the print area (inches). |
| aX2 | [Double] Right side of the print area (inches). |
| aY2 | [Double] Bottom side of the print area (inches). |
| aR1 | [Double] Horizontal corner radius (inches). |
| aR2 | [Double] Vertical corner radius (inches). |
| aPWidth | [Double] Width of the pen (inches). |
| aPStyle | [Integer] Style of the pen. |
| aPColor | [Integer] Color of the pen. |
| aBStyle | [Integer] Style of the brush. |
| aBColor | [Integer] Color of the brush. |
Sub DrawShade( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aColor )
Render a shaded rectangle at the passed coordinates.
| aX1 | [Double] Left side of the print area (inches). |
| aY1 | [Double] Top side of the print area (inches). |
| aX2 | [Double] Right side of the print area (inches). |
| aY2 | [Double] Bottom side of the print area (inches). |
| aColor | [Integer] Color of the rectangle’s interior. |
Sub DrawBorder( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aColor )
Render a bounding rectangle at the passed coordinates.
| aX1 | [Double] Left side of the print area (inches). |
| aY1 | [Double] Top side of the print area (inches). |
| aX2 | [Double] Right side of the print area (inches). |
| aY2 | [Double] Bottom side of the print area (inches). |
| aColor | [Integer] Color of the rectangle’s border. |
Sub DrawLineEx( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aWidth, ByVal aStyle, ByVal aColor )
Render a line at the passed coordinates.
| aX1 | [Double] Left side of the line (inches). |
| aY1 | [Double] Top side of the line (inches). |
| aX2 | [Double] Right side of the line (inches). |
| aY2 | [Double] Bottom side of the line (inches). |
| aWidth | [Double] Width of the line (inches). |
| aStyle | [Integer] Style of the line. |
| aColor | [Integer] Color of the line. |
Sub DrawHRuleEx( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aStyle, ByVal aColor )
Render a horizontal rule/line at the passed coordinates.
| aX1 | [Double] Left side of the line (inches). |
| aY1 | [Double] Top side of the line (inches). |
| aLength | [Double] Length of the line (inches). |
| aStyle | [Integer] Style of the line. |
| aColor | [Integer] Color of the line. |
Sub DrawHRule( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aColor )
Render a horizontal rule/line at the passed coordinates, with a solid pen.
| aX1 | [Double] Left side of the line (inches). |
| aY1 | [Double] Top side of the line (inches). |
| aLength | [Double] Length of the line (inches). |
| aColor | [Integer] Color of the line. |
Sub DrawVRuleEx( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aStyle, ByVal aColor )
Render a vertical rule/line at the passed coordinates.
| aX1 | [Double] Left side of the line (inches). |
| aY1 | [Double] Top side of the line (inches). |
| aLength | [Double] Length of the line (inches). |
| aStyle | [Integer] Style of the line. |
| aColor | [Integer] Color of the line. |
Sub DrawVRule( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aColor )
Render a vertical rule/line at the passed coordinates, with a solid pen.
| aX1 | [Double] Left side of the line (inches). |
| aY1 | [Double] Top side of the line (inches). |
| aLength | [Double] Length of the line (inches). |
| aColor | [Integer] Color of the line. |
Sub QV_EditBar( ByRef arTrait, ByVal aTag, ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2 )
Add an edit bar.
| arTrait | [Object] The trait item object. |
| aTag | [String] Name of the tag to expose/manipulate. |
| aX1 | [Double] Left side of the print area (inches). |
| aY1 | [Double] Top side of the print area (inches). |
| aX2 | [Double] Right side of the print area (inches). |
| aY2 | [Double] Bottom side of the print area (inches). |
Sub QV_TextBox( ByRef arTrait, ByVal aTag, ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2 )
Add a text box.
| arTrait | [Object] The trait item object. |
| aTag | [String] Name of the tag to expose/manipulate. |
| aX1 | [Double] Left side of the print area (inches). |
| aY1 | [Double] Top side of the print area (inches). |
| aX2 | [Double] Right side of the print area (inches). |
| aY2 | [Double] Bottom side of the print area (inches). |
Add a multi-line text box.
| arTrait | [Object] The trait item object. |
| aTag | [String] Name of the tag to expose/manipulate. |
| aX1 | [Double] Left side of the print area (inches). |
| aY1 | [Double] Top side of the print area (inches). |
| aX2 | [Double] Right side of the print area (inches). |
| aY2 | [Double] Bottom side of the print area (inches). |
Add a trait selection window button.
| arTrait | [Object] The trait item object. |
| aTag | [String] Name of the tag to expose/manipulate. |
| aLabel | [String] Label for the control. |
| aX1 | [Double] Left side of the print area (inches). |
| aY1 | [Double] Top side of the print area (inches). |
| aX2 | [Double] Right side of the print area (inches). |
| aY2 | [Double] Bottom side of the print area (inches). |
Sub QV_AddEditControlInTwips( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aType, ByRef arTrait, ByVal aTag, ByVal aLabel )
Add an (interactive) editing control, specifying the coordinates and width in twips.
| aX1 | [Double] Left side of the print area (twips). |
| aY1 | [Double] Top side of the print area (twips). |
| aX2 | [Double] Right side of the print area (twips). |
| aY2 | [Double] Bottom side of the print area (twips). |
| aType | [Integer] Quick View Field Type. |
| arTrait | [Object] The trait item object. |
| aTag | [String] Name of the tag to expose/manipulate. |
| aLabel | [String] Label for the control. |
Sub QV_DrawEditHotspotInTwips( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2 )
Draw a shade rectangle, specifying the coordinates and width in twips.
| aX1 | [Double] Left side of the print area (twips). |
| aY1 | [Double] Top side of the print area (twips). |
| aX2 | [Double] Right side of the print area (twips). |
| aY2 | [Double] Bottom side of the print area (twips). |
A fast, easy-to-use, dynamic array class
| Pseudo-Constants | |
| c_Version | Class version string. |
| c_BaseAllocSize | Default base allocation size. |
| Private Properties | |
| pArray | Vector array. |
| pCount | Element count. |
| pCapacity | Total number of available elements. |
| pBaseAlloc | Base allocation size. |
| Private Methods | |
| Class_Initialize | Prepares the object for use. |
| Class_Terminate | Prepares the object for destruction. |
| pQSort | Sorts elements within a range. |
| pQSortCmpAsc | Ascending comparator for pQSort. |
| pQSortCmpDesc | Descending comparator for pQSort. |
| Public Properties | |
| Reserve (Accessor) | Get the base allocation size. |
| Reserve (Mutator) | Set the base allocation size. |
| Capacity (Accessor) | Get the current number of elements that the vector can hold without needing to allocate more storage. |
| Empty (Accessor) | Test if the vector is empty. |
| Count (Accessor) | Get the count of all elements. |
| LBound (Accessor) | Get the index of the first element. |
| UBound (Accessor) | Get the index of the last element. |
| AsArray (Accessor) | Get an array containing the values of all elements. |
| Item (Accessor) | Get the value of the element at the passed index. |
| Item (Mutator) | Assign the passed value to the element at the passed index. |
| First (Accessor) | Get the value of the first element. |
| First (Mutator) | Assign the passed value to the first element. |
| Last (Accessor) | Get the value of the last element. |
| Last (Mutator) | Assign the passed value to the last element. |
| Insert (Mutator) | Insert the passed value as a new element at the passed index. |
| Prepend (Mutator) | Add a new element to the beginning of the vector and assign it the passed value. |
| Append (Mutator) | Add a new element to the end of the vector and assign it the passed value. |
| Push (Mutator) | Add a new element to the end of the vector and assign it the passed value. |
| Pop (Mutator) | Delete the last element and return its value. |
| Enqueue (Mutator) | Add a new element to the end of the vector and assign it the passed value. |
| Dequeue (Mutator) | Delete the first element and return its value. |
| Public Methods | |
| Join | Return a string containing the values of all elements joined by the passed delimiter. |
| Find | Search for the passed value among the elements. |
| Contains | Test for the presence of the passed value among the elements. |
| Sort | Sorts all elements in ascending order. |
| SortRev | Sorts all elements in descending order. |
| Clear | Deletes all elements and resets the vector to the current base allocation size. |
| Delete | Delete the element at the passed index and return its value. |
Private Sub pQSort( ByVal aFirst, ByVal aLast, ByVal aSortDesc )
Sorts elements within a range.
| aFirst | [Integer] Index of the first element of the range. |
| aLast | [Integer] Index of the second element of the range. |
| aSortDesc | [Boolean] Whether or not to sort descending; FALSE sorts ascending, TRUE sorts descending. |
Private Function pQSortCmpAsc( ByVal aItem1, ByVal aItem2 )
Ascending comparator for pQSort.
| aItem1 | [Variant] First item. |
| aItem2 | [Variant] Second item. |
[Integer] Comparison result; -1 if aItem1 is less than aItem2, 0 if aItem1 is equal to aItem2, 1 if aItem1 is greater than aItem2.
Private Function pQSortCmpDesc( ByVal aItem1, ByVal aItem2 )
Descending comparator for pQSort.
| aItem1 | [Variant] First item. |
| aItem2 | [Variant] Second item. |
[Integer] Comparison result; 1 if aItem1 is less than aItem2, 0 if aItem1 is equal to aItem2, -1 if aItem1 is greater than aItem2.
Public Property Let Reserve( ByVal aCount )
Set the base allocation size. If the new base allocation size is less than the current capacity, storage will be reallocated to contain the current elements. This is a non-destructive operation.
| aCount | [Integer] New base allocation size. |
Public Property Let Item( ByVal aIdx, ByVal aVal )
Assign the passed value to the element at the passed index. If the passed index exceeds the current capacity, the vector will be grown to accommodate the new index.
| aIdx | [Integer] Index at which to assign the new element. |
| aVal | [Variant] Value to assign. |
Public Property Let Insert( ByVal aIdx, ByVal aVal )
Insert the passed value as a new element at the passed index. If the passed index exceeds the current capacity, the vector will be grown to accommodate the new index.
| aIdx | [Integer] Index at which to insert the new element. |
| aVal | [Variant] Value to assign. |
Public Function [Join]( ByVal aDelim )
Return a string containing the values of all elements joined by the passed delimiter.
| aDelim | [String] Delimiter to use. |
[String] A string containing the values of all elements joined by the passed delimiter or an empty string, if the vector is empty.
A checkbox rendering class
| Pseudo-Constants | |
| c_Version | Class version string. |
| Private Properties | |
| pBreakPoints | Breakpoints vector. |
| pShowValues | Show values state. |
| pBaseBorderColor | Base border color. |
| pBaseFont | Base font for values. |
| pBaseFontColor | Base font color for values. |
| pBaseFontSize | Base font size for values. |
| pMaxFontSize | Maximum font size for values. |
| pMinFontSize | Minimum font size for values. |
| pStartValue | Starting value. |
| pStopValue | Stopping value. |
| pGroupCount | Number of groups. |
| pGroupSize | Number of checkboxes per group. |
| pBoxSpace | Horizontal space between boxes, within a group (inches). |
| pColumnSpace | Horizontal (column) space between groups (inches). |
| pRowSpace | Vertical (row) space between groups (inches). |
| pLeft | Left X-coordinate (inches). |
| pTop | Top Y-coordinate (inches). |
| pWidth | Width (inches). |
| Private Properties (internal use) | |
| pTotalHeight | Calculated height. |
| pGroupWidth | Width of a group of boxes (inches). |
| pBoxWidth | Width of each box (inches). |
| Private Methods | |
| Class_Initialize | Prepares the object for use. |
| Class_Terminate | Prepares the object for destruction. |
| Public Properties | |
| Left (Accessor) | Get the left X-coordinate. |
| Left (Mutator) | Set the left X-coordinate. |
| Top (Accessor) | Get the top Y-coordinate. |
| Top (Mutator) | Set the top Y-coordinate. |
| Width (Accessor) | Get the width dimension. |
| Width (Mutator) | Set the width dimension. |
| ShowValues (Accessor) | Get the show values state. |
| ShowValues (Mutator) | Set the show values state. |
| BaseBorderColor (Accessor) | Get the base border color. |
| BaseBorderColor (Mutator) | Set the base border color. |
| BaseFont (Accessor) | Get the base font for checkbox values. |
| BaseFont (Mutator) | Set the base font for checkbox values. |
| BaseFontColor (Accessor) | Get the base font color for checkbox values. |
| BaseFontColor (Mutator) | Set the base font color for checkbox values. |
| BaseFontSize (Accessor) | Get the base font size for checkbox values. |
| BaseFontSize (Mutator) | Set the base font size for checkbox values. |
| MaxFontSize (Accessor) | Get the maximum font size for checkbox values. |
| MaxFontSize (Mutator) | Set the maximum font size for checkbox values. |
| MinFontSize (Accessor) | Get the minimum font size for checkbox values. |
| MinFontSize (Mutator) | Set the minimum font size for checkbox values. |
| StartValue (Accessor) | Get the beginning value. |
| StartValue (Mutator) | Set the beginning value. |
| StopValue (Accessor) | Get the ending value. |
| StopValue (Mutator) | Set the ending value. |
| GroupCount (Accessor) | Get the checkbox group count. |
| GroupCount (Mutator) | Set the checkbox group count. |
| GroupSize (Accessor) | Get the checkbox group size. |
| GroupSize (Mutator) | Set the checkbox group size. |
| BoxSpace (Accessor) | Get the checkbox spacer size. |
| BoxSpace (Mutator) | Set the checkbox spacer size. |
| ColumnSpace (Accessor) | Get the checkbox group horizontal (column) spacer size. |
| ColumnSpace (Mutator) | Set the checkbox group horizontal (column) spacer size. |
| RowSpace (Accessor) | Get the checkbox group vertical (row) spacer size. |
| RowSpace (Mutator) | Set the checkbox group vertical (row) spacer size. |
| Public Methods | |
| Clear | Deletes all breakpoints and reinitializes the object to default settings. |
| AddBreakpointEx | Add a breakpoint. |
| AddBreakpoint | Add a breakpoint. |
| ClearBreakpoints | Deletes all breakpoints. |
| CalcHeight | Calculate the height required to render the checkboxes based on the current settings. |
| RenderCheckboxes | Renders the checkboxes. |
Public Sub AddBreakpointEx( ByVal aValue, ByVal aFontColor, ByVal aBorderColor, ByVal aShadeColor )
Add a breakpoint.
| aValue | [Integer] Breakpoint value. |
| aFontColor | [Integer] Font color of checkbox values associated with this breakpoint. |
| aBorderColor | [Integer] Border color of checkboxes associated with this breakpoint. |
| aShadeColor | [Integer] Background color of checkboxes associated with this breakpoint. |
Sheet options handler; called by GCA and so must exist.
Sub CharacterSheetOptions()
Sheet options version checker and upgrader.
Sub SheetOptions_VersionCheck()
Main event handler; called by GCA and so must exist.
Sub Main()
Print the page one header.
Sub Static_PageOneHeader()
Print the primary statistic block.
Sub Static_PrimaryStats()
Render a statistic item.
Sub PrimaryStats_RenderItem( ByVal aStat, ByVal aLeft, ByVal aRight, ByVal aHeight, ByVal aShowCost, ByVal aShade )
Print the wound/usage recording block.
Sub Block_WoundUsage()
Render the hit and fatigue points record blanks.
Sub WoundUsage_RenderRecordBlanks()
Render the hit points checkboxes.
Sub WoundUsage_RenderHPCheckboxes( ByVal aDrawSeparator )
Render the hit points breakpoints chart.
Function WoundUsage_RenderHPBreakpointsChart( ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aCalc )
Render the fatigue points checkboxes.
Sub WoundUsage_RenderFPCheckboxes( ByVal aDrawSeparator )
Render the fatigue points breakpoints chart.
Function WoundUsage_RenderFPBreakpointsChart( ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aCalc )
Render the stress points checkboxes.
Sub WoundUsage_RenderSPCheckboxes( ByVal aDrawSeparator )
Render the stress points breakpoints chart.
Function WoundUsage_RenderSPBreakpointsChart( ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aCalc )
Render the energy reserve checkboxes.
Sub WoundUsage_RenderERCheckboxes( ByVal aDrawSeparator )
Render the power item checkboxes.
Sub WoundUsage_RenderPICheckboxes( ByVal aDrawSeparator )
Print the ancillary statistics blocks.
Sub Block_AncillaryBlocks()
Render the telekinesis ancillary block.
Sub AncillaryBlocks_RenderTelekinesis()
Render the “threshold limited magic”/”unlimited mana” ancillary block.
Sub AncillaryBlocks_RenderUMana( ByRef arThresh, ByRef arRecovery )
Render the Mage: The Ascension ancillary block.
Sub AncillaryBlocks_RenderMage( ByRef arArete )
Print the lifting feats block.
Sub Block_LiftingFeats()
Print the slam table block.
Sub Block_SlamTable()
Print the encumbrance table block.
Sub Block_EncumbranceTable()
Print the defenses block (active & passive).
Sub Block_Defenses()
Render the expanded damage resistances table sub-block.
Sub Defenses_DamageResistances( ByVal aSubColCount )
Render the paper-doll sub-block.
Sub Defenses_PaperDoll()
Print the reaction modifiers block.
Sub Block_ReactionModifiers()
Print the cultural familiarity block.
Sub Block_CulturalList( ByVal aBlanks )
Render the passed cultural familiarity trait object.
Sub CulturalList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Test if the passed trait object is a cultural familiarity and should be printed.
Function CulturalList_IsPrintable( ByRef arTrait )
Test if the passed trait object is a native cultural familiarity.
Function CulturalList_IsNative( ByRef arTrait )
Print the language block.
Sub Block_LanguageList( ByVal aBlanks )
Render the passed language trait object.
Sub LanguageList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Test if the passed trait object is a language and should be printed.
Function LanguageList_IsPrintable( ByRef arTrait )
Test if the passed trait object is a native language.
Function LanguageList_IsNative( ByRef arTrait )
Print the templates and meta-traits, ads, perks, disads, and quirks blocks.
Sub Block_AdList( ByVal aType, ByVal aBlanks )
Render the passed advantage-type trait object.
Sub AdList_RenderItem( ByRef arTrait, ByVal aType, ByVal aIndent, ByVal aParent, ByVal aHeader )
Test if the passed trait object is an advantage-type trait and should be printed.
Function AdList_IsPrintable( ByRef arTrait, ByVal aType, ByVal aIsChild )
Print the skills, techniques, ritual magic paths, and spells blocks.
Sub Block_SkillList( ByVal aType, ByVal aBlanks )
Render the passed skill-type trait object.
Sub SkillList_RenderItem( ByRef arTrait, ByVal aType, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Test if the passed trait object is an skill-type trait and should be printed.
Function SkillList_IsPrintable( ByRef arTrait, ByVal aType, ByVal aIsChild )
Print the size and speed/range table block.
Sub Block_SizeSpeedRangeTable()
Print the humanoid hit location table block.
Sub Block_HumanoidHitLocationTable()
Create the melee & ranged attack lists.
Sub CreateAttackLists()
Print the melee attack table block.
Sub Block_MeleeAttackList( ByVal aBlanks )
Render the passed melee attack mode trait object.
Sub MeleeAttackList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Test if the passed trait object contains melee attack modes and should be printed.
Function MeleeAttackList_IsPrintable( ByRef arTrait )
Print the ranged attack table block.
Sub Block_RangedAttackList( ByVal aBlanks )
Render the passed ranged attack mode trait object.
Sub RangedAttackList_RenderItem( ByRef arTrait, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel )
Test if the passed trait object contains ranged attack modes and should be printed.
Function RangedAttackList_IsPrintable( ByRef arTrait )
Render the attack field notes chart.
Function AttackList_RenderFieldNotesChart( ByVal aCalc )
Print the spell grimoire block.
Sub Block_GrimoireList( ByVal aBlanks )
Render the passed spell trait object.
Sub GrimoireList_RenderItem( ByRef arTrait, ByVal aHeader, ByVal aLabel )
Test if the passed trait object is a spell and should be printed.
Function GrimoireList_IsPrintable( ByRef arTrait )
Filter non-colleges from the passed spell category string.
Function GrimoireList_FilterCats( ByVal aCatTag )
Print the equipment block.
Sub Block_EquipmentList()
Print the load-out block.
Sub Block_LoadOutList()
Render the passed equipment item trait object.
Function EquipmentList_RenderItem( ByRef arTrait, ByVal aType, ByVal aIndent, ByVal aParent, ByVal aHeader, ByVal aLabel, ByVal aIsPKid )
Test if the passed trait object is an equipment item and should be printed.
Function EquipmentList_IsPrintable( ByRef arTrait, ByVal aType )
Print the campaign log block.
Sub Block_CampaignLog()
Render the passed campaign log entry object.
Sub CampaignLog_RenderEntry( ByRef arTrait, ByVal aHeader )
Print the points summary block.
Sub Block_PointSummary( ByVal aBottom )
Print the character portrait block.
Sub Block_Portrait()
Print the character description block.
Sub Block_Description()
Print the character notes block.
Sub Block_Notes()
Print the character portrait, description, and notes at the end of the sheet.
Sub Static_PortraitDescAndNotes()
Test if the character description and/or notes exceed one column in length.
Function DescOrNotesOverflowsColumn()
Test if the character description exceeds one column in length.
Function DescOverflowsColumn()
Test if the character notes exceed one column in length.
Function NotesOverflowsColumn()
Print the scratch pad block.
Sub Block_ScratchPad()
Reset/clear the current footnotes.
Sub ResetFootnotes()
Render the current footnotes.
Sub RenderFootnotes()
Calculate the minimum height of the current footnotes based on printing within 1-3 sub-columns.
Function CalcFootnotesHeight()
Set the passed text as a footnote and return its symbol.
Function SetFootnote( ByVal aText )
Register an aggregate of all bonus and conditional footnotes for the passed trait object and block flag as a footnote and return the symbol.
Function GetFootnote( ByRef arTrait, ByVal aBlock )
Aggregate and return all bonus and conditional footnotes for the passed trait object and block flag.
Function GetFootnoteText( ByRef arTrait, ByVal aBlock )
Fetch a trait item object reference to the passed trait fullname and type.
Function FetchTraitByNameAndExt( ByRef arTrait, ByVal aFullName, ByVal aType )
Fetch a trait item object reference to the passed trait name and type.
Function FetchTraitByNameOnly( ByRef arTrait, ByVal aName, ByVal aType )
Fetch a trait item object reference to the passed trait symbol and type.
Function FetchTraitBySymbol( ByRef arTrait, ByVal aSymbol, ByVal aType )
Get the value of the passed tag name from the passed trait fullname and type.
Function GetTraitTagValue( ByVal aFullName, ByVal aTag, ByVal aType )
Get the relative-trait-score string from the passed relative-trait string and score.
Function GetRelativeTrait( ByVal aTrait, ByVal aScore )
Initialize the page settings.
Sub PageSetup()
Initialize the font settings.
Sub FontSetup()
Initialize the drawing settings (pen & brush values).
Sub DrawSetup()
Test to see if the passed height will not fit within the space available to the current column.
Function NotEnoughSpace( ByVal aHeight )
Set column usage; one column or both together (whole page).
Sub SetColumnUsage( ByVal aNumCols )
Set the currently active column.
Sub SwitchToColumn( ByVal aCol )
Toggle the active column.
Sub ToggleColumn()
Update the top of the currently active column.
Sub UpdateColumnTops()
Set the top Y-coordinate of the currently active column.
Sub SetColumnTop( ByVal aTop )
Set the bottom Y-coordinate of the currently active column.
Sub SetColumnBottom( ByVal aBottom )
Advance to the next column, starting a new page if necessary.
Sub AdvanceToNextColumn()
Start a new page.
Sub StartNewPage()
Initialize the header and footer font settings.
Sub SetHeaderFont()
Set the page/sheet header.
Sub SetHeader()
Set the page/sheet footer.
Sub SetFooter()
Set the font settings (name, size, color, bold, italic, underline).
Sub SetFont( ByVal aFont )
Calculate largest font size that will allow the passed text to fit within the passed dimensions.
Function CalcFontSize( ByVal aText, ByVal aFont, ByVal aSize, ByVal aWidth, ByVal aHeight )
Calculate the height of the passed text based on the passed width and current font settings.
Function RealTextHeight( ByVal aText, ByVal aWidth )
Calculate the height of the passed text based on the passed font settings and passed width.
Function CalcHeightEx( ByVal aText, ByVal aFont, ByVal aSize, ByVal aWidth )
Calculate the height of the passed text based on the passed font settings and passed width.
Function CalcHeight( ByVal aText, ByVal aFont, ByVal aWidth )
Calculate the width of the passed text based on the passed font settings.
Function CalcWidthEx( ByVal aText, ByVal aFont, ByVal aSize )
Calculate the width of the passed text based on the passed font settings.
Function CalcWidth( ByVal aText, ByVal aFont )
Test if the passed trait object MUST be skipped.
Function IsSkipped( ByRef arTrait )
Test if the passed trait object should be hidden.
Function IsHidden( ByRef arTrait, ByVal aHideFlag )
Test if the passed trait object is locked.
Function IsLocked( ByRef arTrait )
Test if the passed statistc exists.
Function StatExists( ByVal aStat )
Test if the passed statistc exists and has a non-zero value.
Function StatNotEmpty( ByVal aStat )
Test if the passed bit-flags are set within the bit-field contained within the passed option name.
Function OptionFlagSet( ByVal aOption, ByVal aFlags )
Test if the passed bit-flags are set within the passed bit-field.
Function IsFlagSet( ByVal aField, ByVal aFlags )
Test if the passed value should be considered a “not applicable/available” value.
Function IsNA( ByVal aText )
Round the passed number to the next integer of greater magnitude.
Function RoundGreater( ByVal aNum )
Round the passed number to the next integer of lesser magnitude.
Function RoundLesser( ByVal aNum )
Round the passed number to the next larger integer.
Function Ceil( ByVal aNum )
Round the passed number to the next smaller integer.
Function Floor( ByVal aNum )
Convert the passed number to a normalized scientific “e” notation string.
Function NumToSci( ByVal aNum, ByVal aSigDigits )
Convert the passed scientific “e” notation string to a number.
Function SciToNum( ByVal aNum )
Determine which of the passed numbers is the largest.
Function Max( ByVal aVal1, ByVal aVal2 )
Determine which of the passed numbers is the smallest.
Function Min( ByVal aVal1, ByVal aVal2 )
Calculate the average (arithmetic mean) of the passed numbers.
Function Avg( ByVal aVal1, ByVal aVal2 )
Determine which of the numbers within the passed array is the largest.
Function MaxList( ByVal aList() )
Determine which of the numbers within the passed array is the smallest.
Function MinList( ByVal aList() )
Calculate the average (arithmetic mean) of the numbers within the passed array.
Function AvgList( ByVal aList() )
Round the passed number to the GURPS “over” threshold.
Function RoundGURPSThreshOver( ByVal aNum )
Round the passed number to the GURPS “under” threshold.
Function RoundGURPSThreshUnder( ByVal aNum )
Convert the passed simple numeric string, from virtually any locale, to a double.
Function StrToDbl( ByVal aNumStr )
Convert the passed simple numeric string, from virtually any locale, to a long.
Function StrToLng( ByVal aNumStr )
Accumulate the dice within the passed array.
Function DiceAccumulator( ByVal aDice() )
Trim line termination from the end of the passed string.
Function Chomp( ByVal aText )
Uppercase the first character of the passed string.
Function UCFirst( ByVal aText )
Uppercase the first character of every word in the passed string.
Function UCWords( ByVal aText )
Convert an equipment mass measurement to the appropriate scaled unit-type.
Function GetEquipMass( ByVal aMeasure, ByVal aUnit )
Convert an equipment mass measurement to the appropriate scaled unit.
Function GetEquipMassUnit( ByVal aMeasure, ByVal aUnit )
Convert a measurement to the appropriate scaled unit.
Function GetScaledUnit( ByVal aMeasure, ByVal aUnit )
Convert a mass measurement, from an assumed unit-type, to the appropriate scaled unit.
Function GetScaledMassUnit( ByVal aMeasure )
Convert a distance/length measurement, from an assumed or integral unit-type, to the appropriate scaled unit.
Function GetScaledLengthUnit( ByVal aMeasure )
Convert a distance/length unit to its normalized abbreviated form.
Function AbbreviateLengthUnit( ByVal aUnit )
Test if the passed string could be an RTF document or fragment.
Function IsTextRTF( ByVal aText )
Creates and returns an RTF document from the passed font name list, color list, and RTF fragment.
Function CreateRtfDoc( ByVal aFonts(), ByVal aColors(), ByVal aText )
Creates and returns an RTF font table from the passed font name list.
Function CreateRtfFontTbl( ByVal aFonts() )
Creates and returns an RTF color table from the passed color list.
Function CreateRtfColorTbl( ByVal aColors() )
Get an RTF font setting command for the passed font.
Function GetRtfFont( ByVal aFont )
Print the passed text, making necessary adjustments if it is RTF.
Sub TextBoxEx( ByVal aText, ByVal aLeft, ByVal aTop, ByVal aWidth, ByVal aHeight, ByVal aWrap )
Render an image centered within the passed area, scaled if necessary.
Sub DrawImage( ByVal aImage, ByVal aX, ByVal aY, ByVal aW, ByVal aH, ByVal aUpscale )
Render a rectangle at the passed coordinates.
Sub DrawRectangleEx( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aR1, ByVal aR2, ByVal aPWidth, ByVal aPStyle, ByVal aPColor, ByVal aBStyle, ByVal aBColor )
Render a shaded rectangle at the passed coordinates.
Sub DrawShade( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aColor )
Render a bounding rectangle at the passed coordinates.
Sub DrawBorder( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aColor )
Render a line at the passed coordinates.
Sub DrawLineEx( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aWidth, ByVal aStyle, ByVal aColor )
Render a horizontal rule/line at the passed coordinates.
Sub DrawHRuleEx( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aStyle, ByVal aColor )
Render a horizontal rule/line at the passed coordinates, with a solid pen.
Sub DrawHRule( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aColor )
Render a vertical rule/line at the passed coordinates.
Sub DrawVRuleEx( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aStyle, ByVal aColor )
Render a vertical rule/line at the passed coordinates, with a solid pen.
Sub DrawVRule( ByVal aX1, ByVal aY1, ByVal aLength, ByVal aColor )
Mix two colors.
Function MixColors( ByVal aColor1, ByVal aColor2 )
Write a branded message to the log, except when in Quick View mode.
Sub LogMesg( ByVal aMesg )
Write a branded warning message to the log.
Sub LogWarn( ByVal aMesg )
Write a branded failure/error message to the log.
Sub LogFail( ByVal aMesg )
Pop-up a branded failure/error message dialog box.
Function PopFail( ByVal aMesg )
Pop-up a branded yes/no query dialog box.
Function PopYesNo( ByVal aMesg )
Add the trait selection window buttons to the left margin of the current page.
Sub QV_AddTraitSelectButtons()
Add an edit bar.
Sub QV_EditBar( ByRef arTrait, ByVal aTag, ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2 )
Add a text box.
Sub QV_TextBox( ByRef arTrait, ByVal aTag, ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2 )
Add an (interactive) editing control, specifying the coordinates and width in twips.
Sub QV_AddEditControlInTwips( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2, ByVal aType, ByRef arTrait, ByVal aTag, ByVal aLabel )
Draw a shade rectangle, specifying the coordinates and width in twips.
Sub QV_DrawEditHotspotInTwips( ByVal aX1, ByVal aY1, ByVal aX2, ByVal aY2 )
Prepares the object for use.
Private Sub Class_Initialize()
Prepares the object for destruction.
Private Sub Class_Terminate()
Sorts elements within a range.
Private Sub pQSort( ByVal aFirst, ByVal aLast, ByVal aSortDesc )
Ascending comparator for pQSort.
Private Function pQSortCmpAsc( ByVal aItem1, ByVal aItem2 )
Descending comparator for pQSort.
Private Function pQSortCmpDesc( ByVal aItem1, ByVal aItem2 )
Get the base allocation size.
Public Property Get Reserve()
Set the base allocation size.
Public Property Let Reserve( ByVal aCount )
Get the current number of elements that the vector can hold without needing to allocate more storage.
Public Property Get Capacity()
Test if the vector is empty.
Public Property Get [Empty]()
Get the count of all elements.
Public Property Get Count()
Get the index of the first element.
Public Property Get LBound()
Get the index of the last element.
Public Property Get UBound()
Get an array containing the values of all elements.
Public Property Get AsArray()
Get the value of the element at the passed index.
Public Default Property Get Item( ByVal aIdx )
Assign the passed value to the element at the passed index.
Public Property Let Item( ByVal aIdx, ByVal aVal )
Get the value of the first element.
Public Property Get First()
Assign the passed value to the first element.
Public Property Let First( ByVal aVal )
Get the value of the last element.
Public Property Get Last()
Assign the passed value to the last element.
Public Property Let Last( ByVal aVal )
Insert the passed value as a new element at the passed index.
Public Property Let Insert( ByVal aIdx, ByVal aVal )
Add a new element to the beginning of the vector and assign it the passed value.
Public Property Let Prepend( ByVal aVal )
Add a new element to the end of the vector and assign it the passed value.
Public Property Let Append( ByVal aVal )
Add a new element to the end of the vector and assign it the passed value.
Public Property Let Push( ByVal aVal )
Delete the last element and return its value.
Public Property Get Pop()
Add a new element to the end of the vector and assign it the passed value.
Public Property Let Enqueue( ByVal aVal )
Delete the first element and return its value.
Public Property Get Dequeue()
Return a string containing the values of all elements joined by the passed delimiter.
Public Function [Join]( ByVal aDelim )
Search for the passed value among the elements.
Public Function Find( ByVal aVal )
Test for the presence of the passed value among the elements.
Public Function Contains( ByVal aVal )
Sorts all elements in ascending order.
Public Sub Sort()
Sorts all elements in descending order.
Public Sub SortRev()
Deletes all elements and resets the vector to the current base allocation size.
Public Sub Clear()
Delete the element at the passed index and return its value.
Public Function Delete( ByVal aIdx )
Prepares the object for use.
Private Sub Class_Initialize()
Prepares the object for destruction.
Private Sub Class_Terminate()
Get the left X-coordinate.
Public Property Get [Left]()
Set the left X-coordinate.
Public Property Let [Left]( ByVal aVal )
Get the top Y-coordinate.
Public Property Get Top()
Set the top Y-coordinate.
Public Property Let Top( ByVal aVal )
Get the width dimension.
Public Property Get [Width]()
Set the width dimension.
Public Property Let [Width]( ByVal aVal )
Get the show values state.
Public Property Get ShowValues()
Set the show values state.
Public Property Let ShowValues( ByVal aVal )
Get the base border color.
Public Property Get BaseBorderColor()
Set the base border color.
Public Property Let BaseBorderColor( ByVal aVal )
Get the base font for checkbox values.
Public Property Get BaseFont()
Set the base font for checkbox values.
Public Property Let BaseFont( ByVal aVal )
Get the base font color for checkbox values.
Public Property Get BaseFontColor()
Set the base font color for checkbox values.
Public Property Let BaseFontColor( ByVal aVal )
Get the base font size for checkbox values.
Public Property Get BaseFontSize()
Set the base font size for checkbox values.
Public Property Let BaseFontSize( ByVal aVal )
Get the maximum font size for checkbox values.
Public Property Get MaxFontSize()
Set the maximum font size for checkbox values.
Public Property Let MaxFontSize( ByVal aVal )
Get the minimum font size for checkbox values.
Public Property Get MinFontSize()
Set the minimum font size for checkbox values.
Public Property Let MinFontSize( ByVal aVal )
Get the beginning value.
Public Property Get StartValue()
Set the beginning value.
Public Property Let StartValue( ByVal aVal )
Get the ending value.
Public Property Get StopValue()
Set the ending value.
Public Property Let StopValue( ByVal aVal )
Get the checkbox group count.
Public Property Get GroupCount()
Set the checkbox group count.
Public Property Let GroupCount( ByVal aVal )
Get the checkbox group size.
Public Property Get GroupSize()
Set the checkbox group size.
Public Property Let GroupSize( ByVal aVal )
Get the checkbox spacer size.
Public Property Get BoxSpace()
Set the checkbox spacer size.
Public Property Let BoxSpace( ByVal aVal )
Get the checkbox group horizontal (column) spacer size.
Public Property Get ColumnSpace()
Set the checkbox group horizontal (column) spacer size.
Public Property Let ColumnSpace( ByVal aVal )
Get the checkbox group vertical (row) spacer size.
Public Property Get RowSpace()
Set the checkbox group vertical (row) spacer size.
Public Property Let RowSpace( ByVal aVal )
Deletes all breakpoints and reinitializes the object to default settings.
Public Sub Clear()
Add a breakpoint.
Public Sub AddBreakpointEx( ByVal aValue, ByVal aFontColor, ByVal aBorderColor, ByVal aShadeColor )
Add a breakpoint.
Public Sub AddBreakpoint( ByVal aValue, ByVal aShade )
Deletes all breakpoints.
Public Sub ClearBreakpoints()
Calculate the height required to render the checkboxes based on the current settings.
Public Function CalcHeight()
Renders the checkboxes.
Public Sub RenderCheckboxes()