Class: Wx::AUI::AuiToolBarArt

Inherits:
Object
  • Object
show all
Defined in:
lib/wx/doc/gen/aui/aui_tool_bar_art.rb

Overview

AuiToolBarArt is part of the Wx::AUI class framework and is the base class defining the interface for rendering AuiToolBar.

It is an abstract base class and its concrete Wx::AuiGenericToolBarArt and Wx::AuiMSWToolBarArt subclasses provide the implementations used by default under all non-MSW platforms and under MSW respectively. See also AuiToolBar and wxAUI Overview.

Category: Window Docking (wxAUI)

Requires:

  • USE_AUI

Direct Known Subclasses

AuiDefaultToolBarArt

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::AUI::AuiToolBarArt 



22
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 22

def initialize; end

Instance Method Details

#clone ⇒ Wx::AUI::AuiToolBarArt

Returns:



25
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 25

def clone; end

#draw_background(dc, wnd, rect) ⇒ void

This method returns an undefined value.

Parameters:



73
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 73

def draw_background(dc, wnd, rect) end

#draw_button(dc, wnd, item, rect) ⇒ void

This method returns an undefined value.

Parameters:



93
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 93

def draw_button(dc, wnd, item, rect) end

#draw_control_label(dc, wnd, item, rect) ⇒ void

This method returns an undefined value.

Parameters:



107
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 107

def draw_control_label(dc, wnd, item, rect) end

#draw_drop_down_button(dc, wnd, item, rect) ⇒ void

This method returns an undefined value.

Parameters:



100
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 100

def draw_drop_down_button(dc, wnd, item, rect) end

#draw_gripper(dc, wnd, rect) ⇒ void

This method returns an undefined value.

Parameters:



119
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 119

def draw_gripper(dc, wnd, rect) end

#draw_label(dc, wnd, item, rect) ⇒ void

This method returns an undefined value.

Parameters:



86
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 86

def draw_label(dc, wnd, item, rect) end

#draw_overflow_button(dc, wnd, rect, state) ⇒ void

This method returns an undefined value.

Parameters:



126
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 126

def draw_overflow_button(dc, wnd, rect, state) end

#draw_plain_background(dc, wnd, rect) ⇒ void

This method returns an undefined value.

Parameters:



79
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 79

def draw_plain_background(dc, wnd, rect) end

#draw_separator(dc, wnd, rect) ⇒ void

This method returns an undefined value.

Parameters:



113
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 113

def draw_separator(dc, wnd, rect) end

#get_element_size(elementId) ⇒ Integer Also known as: element_size

Returns the size of the given element in DIPs.

This function is typically more convenient to override, as it can just return the same value as was passed to #set_element_size, but it shouldn’t usually be called, use #get_element_size_for_window instead.

The size of the element in DIPs.

Parameters:

Returns:

  • (Integer) 


168
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 168

def get_element_size(elementId) end

#get_element_size_for_window(elementId, window) ⇒ Integer Also known as: element_size_for_window

Get the element size scaled by the DPI of the given window.

This function should be used to get the size of the element in pixels. The default version delegates to #get_element_size, override this function if a different behaviour (e.g. to use some smarter algorithm for scaling instead of just multiplying by the DPI factor) is needed.

The size of the element in pixels.

Parameters:

Returns:

  • (Integer)

See Also:



158
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 158

def get_element_size_for_window(elementId, window) end

#get_flags ⇒ Integer Also known as: flags

Returns:

  • (Integer) 


33
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 33

def get_flags; end

#get_font ⇒ Wx::Font Also known as: font

Returns:



42
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 42

def get_font; end

#get_label_size(dc, wnd, item) ⇒ Wx::Size Also known as: label_size

Return the size of the label for the given item.

Note that the type of dc was DC until wxWidgets 3.3.0, where it was changed to ReadOnlyDC as this function doesn’t modify the DC contents.

Parameters:

Returns:



135
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 135

def get_label_size(dc, wnd, item) end

#get_text_direction ⇒ Wx::AuiTextDirection Also known as: text_direction

Return the direction used for rendering text.

Always returns Wx::AUI::AuiTextDirection::LeftToRight in the base class.

Returns:

  • (Wx::AuiTextDirection) 


66
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 66

def get_text_direction; end

#get_text_orientation ⇒ Integer Also known as: text_orientation

Returns:

  • (Integer) 


51
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 51

def get_text_orientation; end

#get_tool_size(dc, wnd, item) ⇒ Wx::Size Also known as: tool_size

Return the size of the given item.

Note that the type of dc was DC until wxWidgets 3.3.0, where it was changed to ReadOnlyDC as this function doesn’t modify the DC contents.

Parameters:

Returns:



145
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 145

def get_tool_size(dc, wnd, item) end

#set_element_size(elementId, size) ⇒ void

This method returns an undefined value.

Sets the size of the given element in DIPs.

Note that this function takes the size in DPI-independent pixels and this size will be scaled by the factor depending on the DPI being actually used by #get_element_size_for_window. In particular, do not use Window#from_dip for the size argument passed to this function.

Parameters:



177
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 177

def set_element_size(elementId, size) end

#set_flags(flags) ⇒ void Also known as: flags=

This method returns an undefined value.

Parameters:

  • flags (Integer) 


29
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 29

def set_flags(flags) end

#set_font(font) ⇒ void Also known as: font=

This method returns an undefined value.

Parameters:



38
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 38

def set_font(font) end

#set_text_direction(direction) ⇒ void Also known as: text_direction=

This method returns an undefined value.

Set the text direction for rendering text.

Does nothing in the base class, override this function to support vertical text rendering.

Parameters:

  • direction (Wx::AuiTextDirection) 


59
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 59

def set_text_direction(direction) end

#set_text_orientation(orientation) ⇒ void Also known as: text_orientation=

This method returns an undefined value.

Parameters:

  • orientation (Integer) 


47
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 47

def set_text_orientation(orientation) end

#show_drop_down(wnd, items) ⇒ Integer

Show a drop down menu with the given items.

ID of the item selected in the menu or -1 if the menu was dismissed

Parameters:

Returns:

  • (Integer) 


185
 
# File 'lib/wx/doc/gen/aui/aui_tool_bar_art.rb', line 185

def show_drop_down(wnd, items) end