Foxit PDF SDK
fsdk.ButtonItem Class Reference

Public Member Functions

def GetBitmap ()
 Get a bitmap object of button. More...
 
def GetEnable ()
 Get an expression string that determines whether to enable the toolbutton. More...
 
def GetExec ()
 Get the expression string to evaluate when the button is selected. More...
 
def GetLabel ()
 Get a text label to be displayed on the button to the right of the icon. More...
 
def GetMarked ()
 Get an expression string that determines whether the toolbutton is marked. More...
 
def GetName ()
 Get a unique language-independent identifier for the button. More...
 
def GetPos ()
 Get the button number to place the added button in the toolbar. More...
 
def GetTooltip ()
 Get the text to display in the button help text when the mouse is over the toolbutton. More...
 
def Set (name, pos, exec, enable, marked, tooltip, label, bitmap)
 Set values.
More...
 
def SetBitmap (value)
 Set a bitmap object of button. More...
 
def SetEnable (value)
 Set an expression string that determines whether to enable the toolbutton. More...
 
def SetExec (value)
 Set the expression string to evaluate when the button is selected. More...
 
def SetLabel (value)
 Set a text label to be displayed on the button to the right of the icon. More...
 
def SetMarked (value)
 Set an expression string that determines whether the toolbutton is marked. More...
 
def SetName (value)
 Set a unique language-independent identifier for the button. More...
 
def SetPos (value)
 Set the button number to place the added button in the toolbar. More...
 
def SetTooltip (value)
 Set the text to display in the button help text when the mouse is over the toolbutton. More...
 

Detailed Description

This class represents button item.

Member Function Documentation

◆ GetBitmap()

fsdk.ButtonItem.GetBitmap ( )

Get a bitmap object of button.

Returns
A bitmap object of button.

◆ GetEnable()

fsdk.ButtonItem.GetEnable ( )

Get an expression string that determines whether to enable the toolbutton.

Returns
An expression string that determines whether to enable the toolbutton.

◆ GetExec()

fsdk.ButtonItem.GetExec ( )

Get the expression string to evaluate when the button is selected.

Returns
The expression string to evaluate when the button is selected.

◆ GetLabel()

fsdk.ButtonItem.GetLabel ( )

Get a text label to be displayed on the button to the right of the icon.

Returns
A text label to be displayed on the button to the right of the icon.

◆ GetMarked()

fsdk.ButtonItem.GetMarked ( )

Get an expression string that determines whether the toolbutton is marked.

Returns
An expression string that determines whether the toolbutton is marked.

◆ GetName()

fsdk.ButtonItem.GetName ( )

Get a unique language-independent identifier for the button.

Returns
A unique language-independent identifier for the button.

◆ GetPos()

fsdk.ButtonItem.GetPos ( )

Get the button number to place the added button in the toolbar.

Returns
The button number to place the added button in the toolbar.

◆ GetTooltip()

fsdk.ButtonItem.GetTooltip ( )

Get the text to display in the button help text when the mouse is over the toolbutton.

Returns
The text to display in the button help text when the mouse is over the toolbutton.

◆ Set()

def fsdk.ButtonItem.Set (   name,
  pos,
  exec,
  enable,
  marked,
  tooltip,
  label,
  bitmap 
)

Set values.

Parameters
[in]nameA unique language-independent identifier for the button.
[in]posThe button number to place the added button in the toolbar.
[in]execThe expression string to evaluate when the button is selected.
[in]enableAn expression string that determines whether to enable the toolbutton.
[in]markedAn expression string that determines whether the toolbutton is marked.
[in]tooltipThe text to display in the button help text when the mouse is over the toolbutton.
[in]labelA text label to be displayed on the button to the right of the icon.
[in]bitmapA bitmap object of button.
Returns
None.

◆ SetBitmap()

fsdk.ButtonItem.SetBitmap (   value)

Set a bitmap object of button.

Parameters
[in]valueA bitmap object of button.
Returns
None.

◆ SetEnable()

fsdk.ButtonItem.SetEnable (   value)

Set an expression string that determines whether to enable the toolbutton.

Parameters
[in]valueAn expression string that determines whether to enable the toolbutton.
Returns
None.

◆ SetExec()

fsdk.ButtonItem.SetExec (   value)

Set the expression string to evaluate when the button is selected.

Parameters
[in]valueThe expression string to evaluate when the button is selected.
Returns
None.

◆ SetLabel()

fsdk.ButtonItem.SetLabel (   value)

Set a text label to be displayed on the button to the right of the icon.

Parameters
[in]valueA text label to be displayed on the button to the right of the icon.
Returns
None.

◆ SetMarked()

fsdk.ButtonItem.SetMarked (   value)

Set an expression string that determines whether the toolbutton is marked.

Parameters
[in]valueAn expression string that determines whether the toolbutton is marked.
Returns
None.

◆ SetName()

fsdk.ButtonItem.SetName (   value)

Set a unique language-independent identifier for the button.

Parameters
[in]valueA unique language-independent identifier for the button.
Returns
None.

◆ SetPos()

fsdk.ButtonItem.SetPos (   value)

Set the button number to place the added button in the toolbar.

Parameters
[in]valueThe button number to place the added button in the toolbar.
Returns
None.

◆ SetTooltip()

fsdk.ButtonItem.SetTooltip (   value)

Set the text to display in the button help text when the mouse is over the toolbutton.

Parameters
[in]valueThe text to display in the button help text when the mouse is over the toolbutton.
Returns
None.