Table Of Contents

Previous topic

zoombar

Next topic

ZoomBar

This Page

phoenix_title ImageBar

This class holds the background button bar on which the buttons float.


class_hierarchy Inheritance Diagram

Inheritance diagram for class ImageBar

Inheritance diagram of ImageBar


method_summary Methods Summary

__init__ Default class constructor.
GetBarColour Returns the background button bar colour.
GetBitmap Returns the background button bar on which the buttons float.
GetPosition Returns the position of ImageBar, as a Point.
GetSize Returns the size of ImageBar, as a Size.
SetBarColour Sets the background button bar colour.
SetPosition Sets the position of ImageBar.
SetSize Sets the size of ImageBar.

api Class API



class ImageBar(object)

This class holds the background button bar on which the buttons float.


Methods



__init__(self, bitmap=None)

Default class constructor.

Parameters:bitmap – if not None, the bitmap to use as a background button bar on which the buttons float. It should be an instance of Image.


GetBarColour(self)

Returns the background button bar colour.



GetBitmap(self)

Returns the background button bar on which the buttons float.



GetPosition(self)

Returns the position of ImageBar, as a Point.



GetSize(self)

Returns the size of ImageBar, as a Size.



SetBarColour(self, colour, xSize=None, ySize=None)

Sets the background button bar colour.

Parameters:
  • colour – an instance of Colour;
  • xSize – if not None, the new ImageBar width;
  • ySize – if not None, the new ImageBar height.


SetPosition(self, xpos, ypos)

Sets the position of ImageBar.

Parameters:
  • xpos – the x position of the bar;
  • ypos – the y position of the bar.


SetSize(self, xSize, ySize)

Sets the size of ImageBar.

Parameters:
  • xSize – the width of the bar, in pixels;
  • ySize – the height of the bar, in pixels.