| Both sides previous revisionPrevious revision | |
| programming:tge:controls:guimoderntextlistctrl [2011/09/20 23:11] – [Methods] all methods are finally documented Nathan Martin | programming:tge:controls:guimoderntextlistctrl [2011/09/20 23:13] (current) – [Properties] added profile property Nathan Martin |
|---|
| ==== Properties ==== | ==== Properties ==== |
| |
| |//GuiControlProfile//^headerProfile|The control profile that determines fill styles, font settings, etc. for column headers.|| | |//GuiControlProfile//^profile|The control profile that determines fill styles, font settings, etc. for row items.|| |
| | ^ Syntax:|''//**%obj**//.headerProfile = "//**__Value__**//";'' || | | ^ Syntax:|''//**%obj**//.headerProfile = "//**__Value__**//";'' || |
| | |^ //Value//|Profile name to be used.| | | |^ //Value//|Profile name to be used.| |
| | \\ |
| |
| | |
| | |//GuiControlProfile//^headerProfile|The control profile that determines fill styles, font settings, etc. for column headers.|| |
| | | ^ Syntax:|''//**%obj**//.headerProfile = "//**__Value__**//";'' || |
| | | |^ //Value//|Profile name to be used.| |
| \\ | \\ |
| | |
| |
| |//GuiControlProfile//^sortProfile|The control profile that determines the texture and color of the sort order indicator in sorted column headers.|| | |//GuiControlProfile//^sortProfile|The control profile that determines the texture and color of the sort order indicator in sorted column headers.|| |
| | ^ Syntax:|''//**%obj**//.sortProfile = "//**__Value__**//";'' || | | ^ Syntax:|''//**%obj**//.sortProfile = "//**__Value__**//";'' || |
| | |^ //Value//|Profile name to be used.| | | |^ //Value//|Profile name to be used.| |
| |
| \\ | \\ |
| | |
| |
| |//Point2I//^headerGlowOffset|Number of pixels that will need to be offset when drawing a column header cell's texture|| | |//Point2I//^headerGlowOffset|Number of pixels that will need to be offset when drawing a column header cell's texture|| |
| | |^ //Horizontal//|Number of pixels to offset the left and right boundaries of the texture.| | | |^ //Horizontal//|Number of pixels to offset the left and right boundaries of the texture.| |
| |:::|^ //Vertical//|Number of pixels to offset the top and bottom boundaries of the texture.| | |:::|^ //Vertical//|Number of pixels to offset the top and bottom boundaries of the texture.| |
| |
| \\ | \\ |
| | |
| |
| |//Point2I//^rowGlowOffset|Number of pixels that will need to be offset when drawing a row column's texture|| | |//Point2I//^rowGlowOffset|Number of pixels that will need to be offset when drawing a row column's texture|| |
| | |^ //Horizontal//|Number of pixels to offset the left and right boundaries of the texture.| | | |^ //Horizontal//|Number of pixels to offset the left and right boundaries of the texture.| |
| |:::|^ //Vertical//|Number of pixels to offset the top and bottom boundaries of the texture.| | |:::|^ //Vertical//|Number of pixels to offset the top and bottom boundaries of the texture.| |
| |
| \\ | \\ |
| | |
| |
| |//Point2I//^headerTextPadding|Number of additional pixels for padding text when drawing column header cells.|| | |//Point2I//^headerTextPadding|Number of additional pixels for padding text when drawing column header cells.|| |
| | |^ //Horizontal//|Number of horizontal pixels added for text padding.| | | |^ //Horizontal//|Number of horizontal pixels added for text padding.| |
| |:::|^ //Vertical//|Number of vertical pixels added for text padding.| | |:::|^ //Vertical//|Number of vertical pixels added for text padding.| |
| |
| \\ | \\ |
| | |
| |
| |//Point2I//^rowTextPadding|Number of additional pixels for padding text when drawing row column cells.|| | |//Point2I//^rowTextPadding|Number of additional pixels for padding text when drawing row column cells.|| |
| | |^ //Horizontal//|Number of horizontal pixels added for text padding.| | | |^ //Horizontal//|Number of horizontal pixels added for text padding.| |
| |:::|^ //Vertical//|Number of vertical pixels added for text padding.| | |:::|^ //Vertical//|Number of vertical pixels added for text padding.| |
| |
| \\ | \\ |
| | |
| |
| |//Bool//^allowColumnResize|Whether or not user is allowed to resize columns using the mouse cursor.|| | |//Bool//^allowColumnResize|Whether or not user is allowed to resize columns using the mouse cursor.|| |
| | ^ Syntax:|''//**%obj**//.allowColumnResize = //**__Value__**//;''|| | | ^ Syntax:|''//**%obj**//.allowColumnResize = //**__Value__**//;''|| |
| | |^ //Value//|**true** -- User can resize columns using the mouse cursor\\ **false** -- Column resizers are locked and user cannot change them.| | | |^ //Value//|**true** -- User can resize columns using the mouse cursor\\ **false** -- Column resizers are locked and user cannot change them.| |
| |
| \\ | \\ |
| | |
| |
| |//Bool//^allowColumnMove|Whether or not user is allowed to move columns via drag and drop.|| | |//Bool//^allowColumnMove|Whether or not user is allowed to move columns via drag and drop.|| |
| | ^ Syntax:|''//**%obj**//.allowColumnMove = //**__Value__**//;''|| | | ^ Syntax:|''//**%obj**//.allowColumnMove = //**__Value__**//;''|| |
| | |^ //Value//|**true** -- User can move columns using the mouse cursor via drag and drop\\ **false** -- Column positions are locked and user cannot move them.| | | |^ //Value//|**true** -- User can move columns using the mouse cursor via drag and drop\\ **false** -- Column positions are locked and user cannot move them.| |
| |
| \\ | \\ |
| | |
| |
| |//Bool//^useMarkup|Whether the control should use or just ignore markup language within row contents.|| | |//Bool//^useMarkup|Whether the control should use or just ignore markup language within row contents.|| |
| | ^ Syntax:|''//**%obj**//.useMarkup = //**__Value__**//;''|| | | ^ Syntax:|''//**%obj**//.useMarkup = //**__Value__**//;''|| |
| | |^ //Value//|**true** -- Markup language tags will be parsed and processed for text draw manipulation.\\ **false** -- Markup language tags will be ignored as if the control didn't support them and control will behave like GuiTextListCtrl in this regard.| | | |^ //Value//|**true** -- Markup language tags will be parsed and processed for text draw manipulation.\\ **false** -- Markup language tags will be ignored as if the control didn't support them and control will behave like GuiTextListCtrl in this regard.| |
| |
| \\ | \\ |
| | |
| |
| |//Bool//^resizeOnChange|Whether or not to update the control size for the scroller parent control upon content changes such as using the **Add**[**Row**%%|%%**Column**]**()** methods.|| | |//Bool//^resizeOnChange|Whether or not to update the control size for the scroller parent control upon content changes such as using the **Add**[**Row**%%|%%**Column**]**()** methods.|| |
| | ^ Syntax:|''//**%obj**//.resizeOnChange = //**__Value__**//;''|| | | ^ Syntax:|''//**%obj**//.resizeOnChange = //**__Value__**//;''|| |
| | |^ //Value//|**true** -- The control will update its size upon any relevant row or column changes.\\ **false** -- The control will not update its size upon any row or column changes.\\ \\ This property is useful for cases when the scripter is going to be inserting a massive amount of rows such as 5,000 and want to reduce the time it takes to insert the rows by not having the control perform unnecessary maintenance that isn't required until after the scripter is done populating the control with content. Afterwards the scripter can then call the **updateSize()** method to make it possible for the user to scroll through the just added rows. Be sure to change this property back to **true** once done populating the control as to prevent any awkward useability problems when rows are dynamically added or removed later on.| | | |^ //Value//|**true** -- The control will update its size upon any relevant row or column changes.\\ **false** -- The control will not update its size upon any row or column changes.\\ \\ This property is useful for cases when the scripter is going to be inserting a massive amount of rows such as 5,000 and want to reduce the time it takes to insert the rows by not having the control perform unnecessary maintenance that isn't required until after the scripter is done populating the control with content. Afterwards the scripter can then call the **updateSize()** method to make it possible for the user to scroll through the just added rows. Be sure to change this property back to **true** once done populating the control as to prevent any awkward useability problems when rows are dynamically added or removed later on.| |
| |
| \\ | \\ |
| | |
| |
| ==== Methods ==== | ==== Methods ==== |
