Documentation - <button>

A button element must be contained within a <controlpanel> element, and specifies that a button of a particular type should be displayed within the control panel. These <button>'s are used used to display controls for playing/pausing the slideshow, moving to the next or previous slide, or skipping to a particular numbered slide. Note that the order in which the <button>'s are defined within the <controlpanel> is the order (from left to right) in which they will appear.

Parameters

  • type - The button type to display. Valid values are: 'previous', 'next', 'play', 'pause', and 'numbers'. Note that if you include a 'play' button, you should also include a 'pause' button, and the 'play' and 'pause' buttons should be next to next to each other in the buttons list.
  • width (optional, and only applicable when <controlpanel>'s simplebuttons attribute is set to 'true') - The width of the button. (When using graphical buttons, the width is automatically implied, and this attribute is unnecessary)
  • height (optional, and only applicable when <controlpanel>'s simplebuttons attribute is set to 'true') - The height of the button. (When using graphical buttons, the height is automatically implied, and this attribute is unnecessary)
  • color (optional, and only applicable when <controlpanel>'s simplebuttons attribute is set to 'true') - The color of the button in its normal state. The color can be provided by name (e.g. "red", "orange", etc) or by its hexadecimal value (e.g. "#fefefe")
  • overcolor (optional, and only applicable when <controlpanel>'s simplebuttons attribute is set to 'true') - The color of the button when the mouse is held over the button. The color can be provided by name (e.g. "red", "orange", etc) or by its hexadecimal value (e.g. "#fefefe")
  • downcolor (optional, and only applicable when <controlpanel>'s simplebuttons attribute is set to 'true') - The color of the button when the button is pressed. The color can be provided by name (e.g. "red", "orange", etc) or by its hexadecimal value (e.g. "#fefefe")
  • textcolor (optional) - The color of the button's text (if any). The color of the button when the button is pressed. The color can be provided by name (e.g. "red", "orange", etc) or by its hexadecimal value (e.g. "#fefefe")
  • shadowtextcolor (optional) - The color of the button text's shadow (if any). The color of the button when the button is pressed. The color can be provided by name (e.g. "red", "orange", etc) or by its hexadecimal value (e.g. "#fefefe")
  • highlighttextcolor (optional) - The color of the button text when the button is a 'numbers' button and the button corresponds to the screen that is currently being displayed. The color of the button when the button is pressed. The color can be provided by name (e.g. "red", "orange", etc) or by its hexadecimal value (e.g. "#fefefe")

Examples:

<controlpanel x="10" y="10">
<button type="previous"/>
<button type="next" />
<button type="numbers" textcolor="red" shadowtextcolor="blue" highlighttextcolor="white"/>
</controlpanel>

<controlpanel x="10" y="10" simplebuttons="true">
<button type="previous" width="50" height="20" color="#123456" overcolor="#654321" downcolor="#ffffff"/>
<button type="next" width="50" height="20" color="#123456" overcolor="#654321" downcolor="#ffffff"/>
<button type="numbers" width="20" height="10" color="#339900" overcolor="#34ab86" downcolor="#ffcc33" textcolor="red" shadowtextcolor="blue" highlighttextcolor="white"/>
</controlpanel>

Children

Each <button> element may contain the following nested elements:

  • buttonimage (optional)* - An image that should be used for a particular state of the button ('normal', 'over', or 'down').

*Pro version only