Differences

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

Link to this comparison view

desktop:ktbbutton [2019/10/23 05:53] (current)
Line 1: Line 1:
 +====== Notes ======
 +Toolbar items should, generally speaking, be created using the CreateButton,​ CreateControl and CreateSpacer methods of KillerToolbar. This is documented for customization purposes.
  
 +====== Enumerations ======
 +^ Name      ^ Values ​      ^
 +|  | This class exposes no enumerations. |
 +
 +====== Constants ======
 +^ Name      ^ Type     ^ Value       ^
 +|  |  | This class exposes no constants. |
 +
 +====== Events ======
 +^ Definition ​     ^ Description ​      ^
 +|  | This class exposes no events. |
 +
 +====== Methods ======
 +^ Definition ​     ^ Parameters ​     ^ Description ​      ^
 +| Constructor | theName As String, theCaption As String, theHelpTag As String, theIcon As Picture, theIconMask As Picture, theX As Integer, theY As Integer, theWidth As Integer, theHeight As Integer, theOwner As KillerToolBar,​ theEnabled As Boolean, theSelected As Boolean, theIndex As Integer, theIndexAvail As Integer, theMenu As MenuItem | Initialize a new instance. |
 +| ::: | theName As String, theCaption As String, theHelpTag As String, theX As Integer, theY As Integer, theWidth As Integer, theHeight As Integer, theOwner As KillerToolBar,​ theEnabled As Boolean, theIndex As Integer, theIndexAvail As Integer, theRectControl As RectControl | ::: |
 +| ::: | theX As Integer, theY As Integer, theWidth As Integer, theHeight As Integer, theOwner As KillerToolBar,​ theIndex As Integer, theIndexAvail As Integer | ::: |
 +| DrawMoreArrow | g as Graphics | Draws the dropdown chevron icon for buttons with MenuItems. |
 +| MouseDown | g as Graphics | Calls the KTBStyle'​s ButtonDown routine to refresh the item in the display. |
 +| MouseDrag | g as Graphics | Calls the KTBStyle'​s ButtonDrag or DrawSpacer routing to refresh the item in the display. |
 +| MouseEnter | g as Graphics | Initiates the HelpTag process and calls the KTBStyle'​s ButtonOver routine. |
 +| MouseExit |  | Hides any HelpTag which may have been displayed in MouseEnter. |
 +| MouseUp |  | Calls the toolbars MouseClick routine to signify that a click occurred on the button. |
 +| PaintButton | g as Graphics | Depending on the item's properties, will call the various routines in the KTBStyle to update the toolbar item's display. |
 +
 +====== Properties ======
 +^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
 +| Caption | String | ""​ | The caption of the toolbar item. |
 +| Enabled | Boolean | True | Whether the user can interact with this toolbar item. |
 +| Height | Integer | 0 | The height within the display of the toolbar item. |
 +| HelpTag | String | ""​ | HelpTag (tooltip) to display on mouse over. |
 +| Icon | Picture | Nil | The icon used in toolbar item. |
 +| IconMask | Picture | Nil | Optional mask to use for display of the Icon. |
 +| Index | Integer | 0 | Position within the display. |
 +| IndexAvail | Integer | 0 | If the currently assigned index position is available. |
 +| IsDragging | Boolean | False | True if the user is currently dragging the toolbar item. |
 +| IsHidden | Boolean | False | True if the toolbar item is hidden from the view. |
 +| IsSpace | Boolean | False | True if the item is a spacer. |
 +| Menu | MenuItem | Nil | The menu to use for additional selection from the toolbar item. |
 +| Name | String | ""​ | The name used to identify the toolbar item. |
 +| Owner | KillerToolbar | Nil | The parent KillerToolbar instance of this item. |
 +| RectControl | RectControl | The Xojo control contained within this item's display area (IE: TextField).
 +| Selected | Boolean | False | True if the item's selection state is set to True. |
 +| Toggle | Boolean | True | If True, clicks will toggle the selection state of the item. |
 +| Width | Integer | 0 | Width within the view of this item. |
 +| X | Integer | 0 | X position within the view of this item. |
 +| Y | Integer | 0 | Y position within the view of this item. |
 +
 +====== Examples ======
 +There are currently no examples for this class.
 +
 +====== Changes to this Page ======
 +^ Date ^ Edit ^ Editor ^
 +| 02/01/2018 | Document Created | Anthony G. Cyphers
 +
 +|