AGW Logo

agw_title ButtonPanelText

This class is used to hold data about the main caption in ButtonPanel.

hierarchy Inheritance Diagram

Inheritance diagram for: ButtonPanelText

Inheritance diagram of ButtonPanelText


supclasses Known Superclasses


method_summary Methods Summary

__init__Default class constructor.
CreateDCConvenience function to create a wx.DC.
DrawDraws the main caption.
GetBestSizeReturns the best size for the main caption in ButtonPanel.
GetTextReturns the caption text.
SetTextSets the caption text.

API Class API

class ButtonPanelText(Control)[source]

This class is used to hold data about the main caption in ButtonPanel.



__init__(parent, text='')[source]

Default class constructor.

Parameters:
  • parent – the text parent object, an instance of ButtonPanel;
  • text (string) – the actual main caption string.


CreateDC()[source]

Convenience function to create a wx.DC.



Draw(dc, rect)[source]

Draws the main caption. Actually the drawing is done in BPArt.

Parameters:
  • dc – an instance of wx.DC;

  • rect (wx.Rect) – the main caption text client rectangle.


GetBestSize()[source]

Returns the best size for the main caption in ButtonPanel.

Returns:An instance of wx.Size.


GetText()[source]

Returns the caption text.

Returns:A string representing the caption text.


SetText(text='')[source]

Sets the caption text.

Parameters:text (string) – the main caption string.
Tree

Table Of Contents

Previous topic

ButtonPanel

Next topic

Control