| Version: 3.0.1

- Main Page
- Related Pages
- Categories
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | List of all members
wxAuiToolBarItem Class Reference
Window Docking (wxAUI)

`#include <wx/aui/auibar.h>`

## Detailed Description

wxAuiToolBarItem is part of the wxAUI class framework, representing a toolbar element.

See also wxAuiToolBar and wxAUI Overview.

It has a unique id (except for the separators which always have id = -1), the style (telling whether it is a normal button, separator or a control), the state (toggled or not, enabled or not) and short and long help strings. The default implementations use the short help string for the tooltip text which is popped up when the mouse pointer enters the tool and the long help string for the applications status bar (currently not implemented).

##

Library: wxAui
Category: Window Docking (wxAUI)

## Public Member Functions

| wxAuiToolBarItem ()
| Default Constructor.
| wxAuiToolBarItem (const wxAuiToolBarItem &c)
| Assigns the properties of the wxAuiToolBarItem "c" to this.
wxAuiToolBarItem & | operator= (const wxAuiToolBarItem &c)
| Assigns the properties of the wxAuiToolBarItem "c" to this, returning a pointer to this.
void | Assign (const wxAuiToolBarItem &c)
| Assigns the properties of the wxAuiToolBarItem "c" to this.
void | SetWindow (wxWindow *w)
| Assigns a window to the toolbar item.
wxWindow * | GetWindow ()
| Returns the wxWindow* associated to the toolbar item.
void | SetId (int new_id)
| Sets the toolbar item identifier.
int | GetId () const
| Returns the toolbar item identifier.
void | SetKind (int new_kind)
| Sets the wxAuiToolBarItem kind.
int | GetKind () const
| Returns the toolbar item kind.
void | SetState (int new_state)
int | GetState () const
void | SetSizerItem (wxSizerItem *s)
wxSizerItem * | GetSizerItem () const
void | SetLabel (const wxString &s)
const wxString & | GetLabel () const
void | SetBitmap (const wxBitmap &bmp)
const wxBitmap & | GetBitmap () const
void | SetDisabledBitmap (const wxBitmap &bmp)
const wxBitmap & | GetDisabledBitmap () const
void | SetHoverBitmap (const wxBitmap &bmp)
const wxBitmap & | GetHoverBitmap () const
void | SetShortHelp (const wxString &s)
const wxString & | GetShortHelp () const
void | SetLongHelp (const wxString &s)
const wxString & | GetLongHelp () const
void | SetMinSize (const wxSize &s)
const wxSize & | GetMinSize () const
void | SetSpacerPixels (int s)
int | GetSpacerPixels () const
void | SetProportion (int p)
int | GetProportion () const
void | SetActive (bool b)
bool | IsActive () const
void | SetHasDropDown (bool b)
| Set whether this tool has a drop down button.
bool | HasDropDown () const
| Returns whether the toolbar item has an associated drop down button.
void | SetSticky (bool b)
bool | IsSticky () const
void | SetUserData (long l)
long | GetUserData () const
void | SetAlignment (int l)
int | GetAlignment () const

## Constructor & Destructor Documentation

wxAuiToolBarItem::wxAuiToolBarItem | ( |  | ) |

Default Constructor.

wxAuiToolBarItem::wxAuiToolBarItem | ( | const wxAuiToolBarItem & | c | ) |

Assigns the properties of the wxAuiToolBarItem "c" to this.

## Member Function Documentation

void wxAuiToolBarItem::Assign | ( | const wxAuiToolBarItem & | c | ) |

Assigns the properties of the wxAuiToolBarItem "c" to this.

int wxAuiToolBarItem::GetAlignment | ( |  | ) | const

const wxBitmap& wxAuiToolBarItem::GetBitmap | ( |  | ) | const

const wxBitmap& wxAuiToolBarItem::GetDisabledBitmap | ( |  | ) | const

const wxBitmap& wxAuiToolBarItem::GetHoverBitmap | ( |  | ) | const

int wxAuiToolBarItem::GetId | ( |  | ) | const

Returns the toolbar item identifier.

int wxAuiToolBarItem::GetKind | ( |  | ) | const

Returns the toolbar item kind.

const wxString& wxAuiToolBarItem::GetLabel | ( |  | ) | const

const wxString& wxAuiToolBarItem::GetLongHelp | ( |  | ) | const

const wxSize& wxAuiToolBarItem::GetMinSize | ( |  | ) | const

int wxAuiToolBarItem::GetProportion | ( |  | ) | const

const wxString& wxAuiToolBarItem::GetShortHelp | ( |  | ) | const

wxSizerItem* wxAuiToolBarItem::GetSizerItem | ( |  | ) | const

int wxAuiToolBarItem::GetSpacerPixels | ( |  | ) | const

int wxAuiToolBarItem::GetState | ( |  | ) | const

long wxAuiToolBarItem::GetUserData | ( |  | ) | const

wxWindow* wxAuiToolBarItem::GetWindow | ( |  | ) |

Returns the wxWindow* associated to the toolbar item.

bool wxAuiToolBarItem::HasDropDown | ( |  | ) | const

Returns whether the toolbar item has an associated drop down button.

bool wxAuiToolBarItem::IsActive | ( |  | ) | const

bool wxAuiToolBarItem::IsSticky | ( |  | ) | const

wxAuiToolBarItem& wxAuiToolBarItem::operator= | ( | const wxAuiToolBarItem & | c | ) |

Assigns the properties of the wxAuiToolBarItem "c" to this, returning a pointer to this.

void wxAuiToolBarItem::SetActive | ( | bool | b | ) |

void wxAuiToolBarItem::SetAlignment | ( | int | l | ) |

void wxAuiToolBarItem::SetBitmap | ( | const wxBitmap & | bmp | ) |

void wxAuiToolBarItem::SetDisabledBitmap | ( | const wxBitmap & | bmp | ) |

void wxAuiToolBarItem::SetHasDropDown | ( | bool | b | ) |

Set whether this tool has a drop down button.

This is only valid for wxITEM_NORMAL tools.

void wxAuiToolBarItem::SetHoverBitmap | ( | const wxBitmap & | bmp | ) |

void wxAuiToolBarItem::SetId | ( | int | new_id | ) |

Sets the toolbar item identifier.

void wxAuiToolBarItem::SetKind | ( | int | new_kind | ) |

Sets the wxAuiToolBarItem kind.

void wxAuiToolBarItem::SetLabel | ( | const wxString & | s | ) |

void wxAuiToolBarItem::SetLongHelp | ( | const wxString & | s | ) |

void wxAuiToolBarItem::SetMinSize | ( | const wxSize & | s | ) |

void wxAuiToolBarItem::SetProportion | ( | int | p | ) |

void wxAuiToolBarItem::SetShortHelp | ( | const wxString & | s | ) |

void wxAuiToolBarItem::SetSizerItem | ( | wxSizerItem * | s | ) |

void wxAuiToolBarItem::SetSpacerPixels | ( | int | s | ) |

void wxAuiToolBarItem::SetState | ( | int | new_state | ) |

void wxAuiToolBarItem::SetSticky | ( | bool | b | ) |

void wxAuiToolBarItem::SetUserData | ( | long | l | ) |

void wxAuiToolBarItem::SetWindow | ( | wxWindow * | w | ) |

Assigns a window to the toolbar item.