Navigation

Phoenix Logo

phoenix_title wx.lib.agw.aquabutton.AquaButton

This is the main class implementation of AquaButton.


class_hierarchy Class Hierarchy

Inheritance diagram for class AquaButton:

appearance Control Appearance


wxMSW

wxMSW

wxMAC

wxMAC

wxGTK

wxGTK


super_classes Known Superclasses

wx.Control


method_summary Methods Summary

__init__ Default class constructor.
AcceptsFocus Can this window be given focus by mouse click?
DoEnable Overridden base class virtual.
DoGetBestSize Overridden base class virtual. Determines the best size of the
Enable Enables/disables the button.
GetBackgroundColour Returns the button colour when the mouse is not hovering on the button.
GetDefaultAttributes Overridden base class virtual. By default we should use
GetDisabledColour Returns the button colour when it is disabled.
GetFocusColour Returns the button colour when the button has focus.
GetForegroundColour Returns the text colour for AquaButton.
GetHoverColour Returns the button colour when the mouse is hovering on the button.
GetPath Returns a rounded GraphicsPath rectangle.
GetPulseOnFocus Returns whether the pulsing effect is active.
GetRectColour Returns the button rectangular background colour.
GetShadowColour Returns the button shadow colour.
Invalidate Invalidate the saved bitmap and refresh the button.
LightColour Return light contrast of colour. The colour returned is from the scale of
Notify Actually sends a wx.EVT_BUTTON event to the listener (if any).
OnGainFocus Handles the wx.EVT_SET_FOCUS event for AquaButton.
OnKeyDown Handles the wx.EVT_KEY_DOWN event for AquaButton.
OnKeyUp Handles the wx.EVT_KEY_UP event for AquaButton.
OnLeftDown Handles the wx.EVT_LEFT_DOWN event for AquaButton.
OnLeftUp Handles the wx.EVT_LEFT_UP event for AquaButton.
OnLoseFocus Handles the wx.EVT_KILL_FOCUS event for AquaButton.
OnMouseEnter Handles the wx.EVT_ENTER_WINDOW event for AquaButton.
OnMouseLeave Handles the wx.EVT_LEAVE_WINDOW event for AquaButton.
OnPaint Handles the wx.EVT_PAINT event for AquaButton.
OnPulseTimer Handles the wx.EVT_TIMER event for AquaButton.
OnSize Handles the wx.EVT_SIZE event for AquaButton.
SetBackgroundColour Sets the AquaButton background colour.
SetBitmapLabel Sets the bitmap label for the button.
SetDefault This sets the AquaButton to be the default item for the panel or dialog box.
SetDisabledColour Sets the button colour when it is disabled.
SetFocusColour Sets the button colour when the button has focus.
SetForegroundColour Sets the AquaButton foreground (text) colour.
SetHoverColour Sets the button colour when the mouse is hovering on the button.
SetInitialSize Given the current font and bezel width settings, calculate
SetPulseOnFocus Sets whether to enable the pulsing effect on gaining focus or not.
SetRectColour Sets the button rectangular background colour.
SetShadowColour Sets the button shadow colour.
ShouldInheritColours Overridden base class virtual. Buttons usually don’t inherit

api Class API


class AquaButton(wx.Control)

This is the main class implementation of AquaButton.


Methods


__init__(self, parent, id=wx.ID_ANY, bitmap=None, label="", pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.NO_BORDER, validator=wx.DefaultValidator, name="aquabutton")

Default class constructor.

Parameters:
  • parent (wx.Window) – parent window. Must not be None;
  • id (integer) – window identifier. A value of -1 indicates a default value;
  • bitmap (wx.Bitmap) – the button bitmap (if any);
  • label (string) – the button text label;
  • pos (tuple or wx.Point) – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;
  • size (tuple or wx.Size) – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform;
  • style (integer) – the button style (unused);
  • validator (wx.Validator) – the validator associated to the button;
  • name (string) – the button name.

AcceptsFocus(self)

Can this window be given focus by mouse click?

Note

Overridden from wx.Control.


DoEnable(self, enable)

Overridden base class virtual.

Need to Refresh otherwise Enable state change done from a wx.EVT_UPDATE_UI will not show.


DoGetBestSize(self)

Overridden base class virtual. Determines the best size of the button based on the label and bezel size.

Returns:An instance of wx.Size.

Note

Overridden from wx.Control.


Enable(self, enable=True)

Enables/disables the button.

Parameters:enable (bool) – True to enable the button, False to disable it.

Note

Overridden from wx.Control.


GetBackgroundColour(self)

Returns the button colour when the mouse is not hovering on the button.

Returns:An instance of wx.Colour.

Note

Overridden from wx.Control.


GetDefaultAttributes(self)

Overridden base class virtual. By default we should use the same font/colour attributes as the native Button.

Returns:an instance of VisualAttributes.

Note

Overridden from wx.Control.


GetDisabledColour(self)

Returns the button colour when it is disabled.

Returns:An instance of wx.Colour.

GetFocusColour(self)

Returns the button colour when the button has focus.

Returns:An instance of wx.Colour.

GetForegroundColour(self)

Returns the text colour for AquaButton.

Returns:An instance of wx.Colour.

Note

Overridden from wx.Control.


GetHoverColour(self)

Returns the button colour when the mouse is hovering on the button.

Returns:An instance of wx.Colour.

GetPath(self, gc, rc, r)

Returns a rounded GraphicsPath rectangle.

Parameters:
  • gc – an instance of GraphicsContext;
  • rc (wx.Rect) – a client rectangle;
  • r (float) – the radius of the rounded part of the rectangle.
Returns:

A rounded rectangle, an instance of GraphicsPath.

GetPulseOnFocus(self)

Returns whether the pulsing effect is active.

Returns:True if the pulsing effect is active, False otherwise.

GetRectColour(self)

Returns the button rectangular background colour.

Returns:An instance of wx.Colour.

New in version 0.9.7.


GetShadowColour(self)

Returns the button shadow colour.

Returns:An instance of wx.Colour.

New in version 0.9.7.


Invalidate(self)

Invalidate the saved bitmap and refresh the button.


LightColour(self, colour, percent)

Return light contrast of colour. The colour returned is from the scale of colour ==> white.

Parameters:
  • colour – the input colour to be brightened, a valid instance of wx.Colour;
  • percent (integer) – determines how light the colour will be. percent = 100 returns white, percent = 0 returns colour.
Returns:

A light contrast of the input colour, an instance of wx.Colour.

Notify(self)

Actually sends a wx.EVT_BUTTON event to the listener (if any).


OnGainFocus(self, event)

Handles the wx.EVT_SET_FOCUS event for AquaButton.

Parameters:event – a FocusEvent event to be processed.

OnKeyDown(self, event)

Handles the wx.EVT_KEY_DOWN event for AquaButton.

Parameters:event – a KeyEvent event to be processed.

OnKeyUp(self, event)

Handles the wx.EVT_KEY_UP event for AquaButton.

Parameters:event – a KeyEvent event to be processed.

OnLeftDown(self, event)

Handles the wx.EVT_LEFT_DOWN event for AquaButton.

Parameters:event – a MouseEvent event to be processed.

OnLeftUp(self, event)

Handles the wx.EVT_LEFT_UP event for AquaButton.

Parameters:event – a MouseEvent event to be processed.

OnLoseFocus(self, event)

Handles the wx.EVT_KILL_FOCUS event for AquaButton.

Parameters:event – a FocusEvent event to be processed.

OnMouseEnter(self, event)

Handles the wx.EVT_ENTER_WINDOW event for AquaButton.

Parameters:event – a MouseEvent event to be processed.

OnMouseLeave(self, event)

Handles the wx.EVT_LEAVE_WINDOW event for AquaButton.

Parameters:event – a MouseEvent event to be processed.

OnPaint(self, event)

Handles the wx.EVT_PAINT event for AquaButton.

Parameters:event – a PaintEvent event to be processed.

OnPulseTimer(self, event)

Handles the wx.EVT_TIMER event for AquaButton.

Parameters:event – a TimerEvent event to be processed.

Note

This method is only invoked when pulseOnFocus is True.


OnSize(self, event)

Handles the wx.EVT_SIZE event for AquaButton.

Parameters:event – a wx.SizeEvent event to be processed.

SetBackgroundColour(self, colour)

Sets the AquaButton background colour.

Parameters:colour – a valid wx.Colour object.

Note

Overridden from wx.Control.


SetBitmapLabel(self, bitmap)

Sets the bitmap label for the button.

Parameters:bitmap – the bitmap label to set, an instance of wx.Bitmap.

SetDefault(self)

This sets the AquaButton to be the default item for the panel or dialog box.

Note

Under Windows, only dialog box buttons respond to this function. As normal under Windows and Motif, pressing return causes the default button to be depressed when the return key is pressed. See also wx.Window.SetFocus which sets the keyboard focus for windows and text panel items, and TopLevelWindow.SetDefaultItem.

Note

Note that under Motif, calling this function immediately after creation of a button and before the creation of other buttons will cause misalignment of the row of buttons, since default buttons are larger. To get around this, call SetDefault after you have created a row of buttons: wxPython will then set the size of all buttons currently on the panel to the same size.


SetDisabledColour(self, colour)

Sets the button colour when it is disabled.

Parameters:colour – a valid wx.Colour object.

SetFocusColour(self, colour)

Sets the button colour when the button has focus.

Parameters:colour – a valid wx.Colour object.

SetForegroundColour(self, colour)

Sets the AquaButton foreground (text) colour.

Parameters:colour – a valid wx.Colour object.

Note

Overridden from wx.Control.


SetHoverColour(self, colour)

Sets the button colour when the mouse is hovering on the button.

Parameters:colour – a valid wx.Colour object.

SetInitialSize(self, size=None)

Given the current font and bezel width settings, calculate and set a good size.

Parameters:size – an instance of wx.Size or None, in which case the wxWidgets DefaultSize is used instead.

SetPulseOnFocus(self, pulse)

Sets whether to enable the pulsing effect on gaining focus or not.

Parameters:pulse (bool) – True to enable pulsing when the AquaButton gains focus, False to disable this effect.

SetRectColour(self, colour)

Sets the button rectangular background colour.

Parameters:colour – a valid wx.Colour object.

New in version 0.9.7.


SetShadowColour(self, colour)

Sets the button shadow colour.

Parameters:colour – a valid wx.Colour object.

New in version 0.9.7.


ShouldInheritColours(self)

Overridden base class virtual. Buttons usually don’t inherit the parent’s colours.

Note

Overridden from wx.Control.