Class: Wx::AUI::AuiDefaultTabArt

Inherits:

AuiTabArt

• Object
• AuiTabArt
• Wx::AUI::AuiDefaultTabArt

Defined in:

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

Overview

Default art provider for AuiNotebook.

Appearance:

Generic Appearance

Category: Window Docking (wxAUI)

See Also:

• AuiTabArt

Requires:

• USE_AUI

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::AuiDefaultTabArt 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.

• #show_drop_down(wnd, items, activeIdx) ⇒ Integer

Constructor Details

#initialize ⇒ Wx::AUI::AuiDefaultTabArt

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

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 148

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 200

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 222

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 211

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 251

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 226

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 237

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 192

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 186

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 153

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 180

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 168

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 174

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 163

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

#show_drop_down(wnd, items, activeIdx) ⇒ Integer

Parameters:

• wnd (Wx::Window)
• items (Array<Wx::AUI::AuiNotebookPage>)
• activeIdx (Integer)

Returns:

• (Integer)

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

def show_drop_down(wnd, items, activeIdx) end