Class: Wx::AUI::AuiTabArt

Inherits:

Object

• Object
• Wx::AUI::AuiTabArt

Defined in:

lib/wx/doc/gen/aui/aui_tab_art.rb

Overview

Tab art provider defines all the drawing functions used by AuiNotebook.

This allows the AuiNotebook to have a pluggable look-and-feel. By default, a AuiNotebook uses an instance of this class called AuiDefaultTabArt which provides bitmap art and a colour scheme that is adapted to the major platforms’ look. You can either derive from that class to alter its behaviour or write a completely new tab art class. Another example of creating a new AuiNotebook tab bar is AuiSimpleTabArt. Call Wx::AUI::AuiNotebook#set_art_provider to make use of this new tab art.

Category: Window Docking (wxAUI)

Requires:

• USE_AUI

Direct Known Subclasses

AuiDefaultTabArt, AuiSimpleTabArt

Instance Method Summary

• #clone ⇒ Wx::AUI::AuiTabArt

  Clones the art object.

• #draw_background(dc, wnd, rect) ⇒ void

  Draws a background on the given area.

• #draw_button(dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect) ⇒ void

  Draws a button.

• #draw_tab(dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect) ⇒ Integer

  Draws a tab.

• #get_best_tab_ctrl_size(arg, arg1, arg2) ⇒ Integer (also: #best_tab_ctrl_size)

  Returns the tab control size.

• #get_indent_size ⇒ Integer (also: #indent_size)

  Returns the indent size.

• #get_tab_size(dc, wnd, caption, bitmap, active, close_button_state) ⇒ Array(Wx::Size,Integer) (also: #tab_size)

  Returns the tab size for the given caption, bitmap and state.

• #initialize ⇒ Wx::AUI::AuiTabArt constructor

  Constructor.

• #set_active_colour(colour) ⇒ void (also: #active_colour=)

  Sets the colour of the selected tab.

• #set_colour(colour) ⇒ void (also: #colour=)

  Sets the colour of the inactive tabs.

• #set_flags(flags) ⇒ void (also: #flags=)

  Sets flags.

• #set_measuring_font(font) ⇒ void (also: #measuring_font=)

  Sets the font used for calculating measurements.

• #set_normal_font(font) ⇒ void (also: #normal_font=)

  Sets the normal font for drawing labels.

• #set_selected_font(font) ⇒ void (also: #selected_font=)

  Sets the font for drawing text for selected UI elements.

• #set_sizing_info(tab_ctrl_size, tab_count, wnd = nil) ⇒ void

  Sets sizing information.

Constructor Details

#initialize ⇒ Wx::AUI::AuiTabArt

Constructor.

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

def initialize; end

Instance Method Details

#clone ⇒ Wx::AUI::AuiTabArt

Clones the art object.

Returns:

• (Wx::AUI::AuiTabArt)

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

def clone; end

#draw_background(dc, wnd, rect) ⇒ void

This method returns an undefined value.

Draws a background on the given area.

Parameters:

• dc (Wx::DC)
• wnd (Wx::Window)
• rect (Wx::Rect)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 36

def draw_background(dc, wnd, rect) end

#draw_button(dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect) ⇒ void

This method returns an undefined value.

Draws a button.

Parameters:

• dc (Wx::DC)
• wnd (Wx::Window)
• in_rect (Wx::Rect)
• bitmap_id (Integer)
• button_state (Integer)
• orientation (Integer)
• out_rect (Wx::Rect)

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

def draw_button(dc, wnd, in_rect, bitmap_id, button_state, orientation, out_rect) end

#draw_tab(dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect) ⇒ Integer

Draws a tab.

Parameters:

• dc (Wx::DC)
• wnd (Wx::Window)
• page (Wx::AUI::AuiNotebookPage)
• rect (Wx::Rect)
• close_button_state (Integer)
• out_tab_rect (Wx::Rect)
• out_button_rect (Wx::Rect)

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 58

def draw_tab(dc, wnd, page, rect, close_button_state, out_tab_rect, out_button_rect) end

#get_best_tab_ctrl_size(arg, arg1, arg2) ⇒ Integer Also known as: best_tab_ctrl_size

Returns the tab control size.

Parameters:

• arg (Wx::Window)
• arg1 (Array<Wx::AUI::AuiNotebookPage>)
• arg2 (Array(Integer, Integer), Wx::Size)

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 65

def get_best_tab_ctrl_size(arg, arg1, arg2) end

#get_indent_size ⇒ Integer Also known as: indent_size

Returns the indent size.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 70

def get_indent_size; end

#get_tab_size(dc, wnd, caption, bitmap, active, close_button_state) ⇒ Array(Wx::Size,Integer) Also known as: tab_size

Returns the tab size for the given caption, bitmap and state.

Parameters:

• dc (Wx::DC)
• wnd (Wx::Window)
• caption (String)
• bitmap (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image)
• active (Boolean)
• close_button_state (Integer)

Returns:

• (Array(Wx::Size,Integer))

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 81

def get_tab_size(dc, wnd, caption, bitmap, active, close_button_state) end

#set_active_colour(colour) ⇒ void Also known as: active_colour=

This method returns an undefined value.

Sets the colour of the selected tab.

Parameters:

• colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 117

def set_active_colour(colour) end

#set_colour(colour) ⇒ void Also known as: colour=

This method returns an undefined value.

Sets the colour of the inactive tabs.

Parameters:

• colour (Wx::Colour, String, Symbol)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 111

def set_colour(colour) end

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

This method returns an undefined value.

Sets flags.

Parameters:

• flags (Integer)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 87

def set_flags(flags) end

#set_measuring_font(font) ⇒ void Also known as: measuring_font=

This method returns an undefined value.

Sets the font used for calculating measurements.

Parameters:

• font (Wx::Font, Wx::FontInfo)

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

def set_measuring_font(font) end

#set_normal_font(font) ⇒ void Also known as: normal_font=

This method returns an undefined value.

Sets the normal font for drawing labels.

Parameters:

• font (Wx::Font, Wx::FontInfo)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 99

def set_normal_font(font) end

#set_selected_font(font) ⇒ void Also known as: selected_font=

This method returns an undefined value.

Sets the font for drawing text for selected UI elements.

Parameters:

• font (Wx::Font, Wx::FontInfo)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 105

def set_selected_font(font) end

#set_sizing_info(tab_ctrl_size, tab_count, wnd = nil) ⇒ void

This method returns an undefined value.

Sets sizing information.

The wnd argument is only present in wxWidgets 3.1.6 and newer and is required, it only has NULL default value for compatibility reasons.

Parameters:

• tab_ctrl_size (Array(Integer, Integer), Wx::Size)
• tab_count (Integer)
• wnd (Wx::Window) (defaults to: nil)

# File 'lib/wx/doc/gen/aui/aui_tab_art.rb', line 127

def set_sizing_info(tab_ctrl_size, tab_count, wnd=nil) end