Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
desktop:stepbar [2018/04/14 11:09]
127.0.0.1 external edit
desktop:stepbar [2019/10/23 00:53] (current)
Line 12: Line 12:
 ==== Events ==== ==== Events ====
 ^ Definition      ^ Description       ^ ^ Definition      ^ Description       ^
-| StepClicked() | A step on the StepBar has been clicked. |+| StepClicked(ItemClicked as GraffitiStepBarItem, ItemIndex as Integeras Boolean | A step on the StepBar has been clicked, return False to cancel navigation. |
  
 ==== Methods ==== ==== Methods ====
 ^ Definition      ^ Description       ^ ^ Definition      ^ Description       ^
 | AddItem( newItem as GraffitiStepBarItem ) | Add a new StepBarItem to the class. | | AddItem( newItem as GraffitiStepBarItem ) | Add a new StepBarItem to the class. |
-| ItemCount() as [[http://developer.xojo.com/integer|Integer]] | Returns the number of StepBarItems currently displayed. | +| ItemCount() as Integer | Returns the number of StepBarItems currently displayed. | 
-| RemoveItem( Index as [[http://developer.xojo.com/integer|Integer]] ) | Removes the item at the specified index. |+| RemoveItem( Index as Integer ) | Removes the item at the specified index. |
  
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description       ^ ^ Name      ^ Type       ^ Default Value       ^ Description       ^
-| AllowNavigation | [[http://developer.xojo.com/boolean|Boolean]] | False | Allow the user to change the value of the StepBar by clicking steps. | +| AllowNavigation | Boolean | False | Allow the user to change the value of the StepBar by clicking steps. | 
-| BGColorActive | [[http://developer.xojo.com/color|Color]] | &c000000 | Sets the background color for active steps when UseCustomColors is True. | +| BGColorActive | Color | &c000000 | Sets the background color for active steps when UseCustomColors is True. | 
-| BGColorInactive | [[http://developer.xojo.com/color|Color]] | &c000000 | Sets the background color for inactive steps when UseCustomColors is True. | +| BGColorInactive | Color | &c000000 | Sets the background color for inactive steps when UseCustomColors is True. | 
-| BorderColorDark | [[http://developer.xojo.com/color|Color]] | &c000000 | Sets the dark border color when UseCustomColors is True. | +| BorderColorDark | Color | &c000000 | Sets the dark border color when UseCustomColors is True. | 
-| BorderColorLight | [[http://developer.xojo.com/color|Color]] | &c000000 | Sets the light border color when UseCustomColors is True. | +| BorderColorLight | Color | &c000000 | Sets the light border color when UseCustomColors is True. | 
-| BorderRadius | [[http://developer.xojo.com/integer|Integer]] | 20 | The radius of the control’s corners, in pixels. | +| BorderRadius | Integer | 20 | The radius of the control’s corners, in pixels. | 
-| DescriptionBold | [[http://developer.xojo.com/boolean|Boolean]] | False | Determines the font weight of the description text. | +| DescriptionBold | Boolean | False | Determines the font weight of the description text. | 
-| DescriptionColorActive | [[http://developer.xojo.com/color|Color]] | &c000000 | Determines the color for active description text. | +| DescriptionColorActive | Color | &c000000 | Determines the color for active description text. | 
-| DescriptionColorInactive | [[http://developer.xojo.com/color|Color]] | &c000000 | Determines the color for inactive description text. | +| DescriptionColorInactive | Color | &c000000 | Determines the color for inactive description text. | 
-| DescriptionItalic | [[http://developer.xojo.com/boolean|Boolean]] | False | Determines whether the description text is displayed in italics. | +| DescriptionItalic | Boolean | False | Determines whether the description text is displayed in italics. | 
-| DescriptionTextFont | [[http://developer.xojo.com/string|String]] | "System" | Sets the font face for the description text. | +| DescriptionTextFont | String | "System" | Sets the font face for the description text. | 
-| DescriptionTextSize | [[http://developer.xojo.com/integer|Integer]] | 0 | Sets the font size for the description text. | +| DescriptionTextSize | Integer | 0 | Sets the font size for the description text. | 
-| DescriptionUnderline | [[http://developer.xojo.com/boolean|Boolean]] | False | Determines whether the description text is displayed with an underline. | +| DescriptionUnderline | Boolean | False | Determines whether the description text is displayed with an underline. | 
-| PointWidth | [[http://developer.xojo.com/integer|Integer]] | 0 | The width, in pixels, of the point for each step. | +| PointWidth | Integer | 0 | The width, in pixels, of the point for each step. | 
-| SelectedItem | [[http://developer.xojo.com/integer|Integer]] | -1 | Returns the index of the currently selected StepBarItem. | +| SelectedItem | Integer | -1 | Returns the index of the currently selected StepBarItem. | 
-| TitleBold | [[http://developer.xojo.com/boolean|Boolean]] | False | Sets whether the title is displayed in bold. | +| TitleBold | Boolean | False | Sets whether the title is displayed in bold. | 
-| TitleColorActive | [[http://developer.xojo.com/color|Color]] | &c000000 | Determines the color of the active items title. | +| TitleColorActive | Color | &c000000 | Determines the color of the active items title. | 
-| TitleColorInactive | [[http://developer.xojo.com/color|Color]] | &c000000 | Determines the color of inactive items title. | +| TitleColorInactive | Color | &c000000 | Determines the color of inactive items title. | 
-| TitleItalic | [[http://developer.xojo.com/boolean|Boolean]] | False | Sets whether titles are displayed in italics. | +| TitleItalic | Boolean | False | Sets whether titles are displayed in italics. | 
-| TitleTextFont | [[http://developer.xojo.com/string|String]] | "System" | The font face used to display titles. | +| TitleTextFont | String | "System" | The font face used to display titles. | 
-| TitleTextSize | [[http://developer.xojo.com/integer|Integer]] | 0 | The font size used to display titles. | +| TitleTextSize | Integer | 0 | The font size used to display titles. | 
-| TitleUnderline | [[http://developer.xojo.com/boolean|Boolean]] | False | Determines whether the item titles are displayed with an underline. | +| TitleUnderline | Boolean | False | Determines whether the item titles are displayed with an underline. | 
-| UseCustomColors | [[http://developer.xojo.com/boolean|Boolean]] | False | Determines whether the class is drawn with the custom defined colors. |+| UseCustomColors | Boolean | False | Determines whether the class is drawn with the custom defined colors. |
  
 ==== Examples ==== ==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.