Class: Wx::RBN::RibbonAUIArtProvider
- Inherits:
-
RibbonMSWArtProvider
- Object
- RibbonArtProvider
- RibbonMSWArtProvider
- Wx::RBN::RibbonAUIArtProvider
- Defined in:
- lib/wx/doc/gen/rbn/ribbon_art_provider.rb
Overview
This class is untracked and should not be derived from nor instances extended!
Instance Method Summary collapse
-
#clone ⇒ Wx::RBN::RibbonArtProvider
Create a new art provider which is a clone of this one.
-
#draw_button_bar_background(dc, wnd, rect) ⇒ void
Draw the background for a RibbonButtonBar control.
-
#draw_button_bar_button(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) ⇒ void
Draw a single button for a RibbonButtonBar control.
-
#draw_gallery_background(dc, wnd, rect) ⇒ void
Draw the background and chrome for a RibbonGallery control.
-
#draw_gallery_item_background(dc, wnd, rect, item) ⇒ void
Draw the background of a single item in a RibbonGallery control.
-
#draw_minimised_panel(dc, wnd, rect, bitmap) ⇒ void
Draw a minimised ribbon panel.
-
#draw_page_background(dc, wnd, rect) ⇒ void
Draw the background of a ribbon page.
-
#draw_panel_background(dc, wnd, rect) ⇒ void
Draw the background and chrome for a ribbon panel.
-
#draw_scroll_button(dc, wnd, rect, style) ⇒ void
Draw a ribbon-style scroll button.
-
#draw_tab(dc, wnd, tab) ⇒ void
Draw a single tab in the tab region of a ribbon bar.
-
#draw_tab_ctrl_background(dc, wnd, rect) ⇒ void
Draw the background of the tab region of a ribbon bar.
-
#draw_tab_separator(dc, wnd, rect, visibility) ⇒ void
Draw a separator between two tabs in a ribbon bar.
-
#draw_tool(dc, wnd, rect, bitmap, kind, state) ⇒ void
Draw a single tool (for a RibbonToolBar control).
-
#draw_tool_bar_background(dc, wnd, rect) ⇒ void
Draw the background for a RibbonToolBar control.
-
#draw_tool_group_background(dc, wnd, rect) ⇒ void
Draw the background for a group of tools on a RibbonToolBar control.
-
#get_bar_tab_width(dc, wnd, label, bitmap) ⇒ Array(Integer,Integer,Integer,Integer)
(also: #bar_tab_width)
Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
-
#get_colour(id) ⇒ Wx::Colour
(also: #colour)
Get the value of a certain colour setting.
-
#get_panel_client_size(dc, wnd, size, client_offset) ⇒ Wx::Size
(also: #panel_client_size)
Calculate the client size of a panel for a given overall size.
-
#get_panel_ext_button_area(dc, wnd, rect) ⇒ Wx::Rect
(also: #panel_ext_button_area)
Calculate the position and size of the panel extension button.
-
#get_panel_size(dc, wnd, client_size, client_offset) ⇒ Wx::Size
(also: #panel_size)
Calculate the size of a panel for a given client size.
-
#get_scroll_button_minimum_size(dc, wnd, style) ⇒ Wx::Size
(also: #scroll_button_minimum_size)
Calculate the minimum size (in pixels) of a scroll button.
-
#get_tab_ctrl_height(dc, wnd, pages) ⇒ Integer
(also: #tab_ctrl_height)
Calculate the height (in pixels) of the tab region of a ribbon bar.
- #initialize ⇒ Wx::RBN::RibbonAUIArtProvider constructor
-
#set_colour(id, colour) ⇒ void
Set the value of a certain colour setting to the value colour.
-
#set_colour_scheme(primary, secondary, tertiary) ⇒ void
Set all applicable colour settings from a few base colours.
-
#set_font(id, font) ⇒ void
Set the value of a certain font setting to the value font.
Methods inherited from RibbonMSWArtProvider
#draw_help_button, #draw_toggle_button, #get_bar_toggle_button_area, #get_button_bar_button_size, #get_button_bar_button_text_width, #get_colour_scheme, #get_flags, #get_font, #get_gallery_client_size, #get_gallery_size, #get_metric, #get_minimised_panel_minimum_size, #get_page_background_redraw_area, #get_ribbon_help_button_area, #get_tool_size, #set_flags, #set_metric
Methods inherited from RibbonArtProvider
#draw_help_button, #draw_toggle_button, #get_bar_toggle_button_area, #get_button_bar_button_size, #get_button_bar_button_text_width, #get_color, #get_colour_scheme, #get_flags, #get_font, #get_gallery_client_size, #get_gallery_size, #get_metric, #get_minimised_panel_minimum_size, #get_page_background_redraw_area, #get_ribbon_help_button_area, #get_tool_size, #set_color, #set_flags, #set_metric
Constructor Details
#initialize ⇒ Wx::RBN::RibbonAUIArtProvider
1514 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1514 def initialize; end |
Instance Method Details
#clone ⇒ Wx::RBN::RibbonArtProvider
Create a new art provider which is a clone of this one.
1518 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1518 def clone; end |
#draw_button_bar_background(dc, wnd, rect) ⇒ void
This method returns an undefined value.
Draw the background for a Wx::RBN::RibbonButtonBar control.
1698 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1698 def (dc, wnd, rect) end |
#draw_button_bar_button(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) ⇒ void
This method returns an undefined value.
Draw a single button for a Wx::RBN::RibbonButtonBar control.
1710 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1710 def (dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) end |
#draw_gallery_background(dc, wnd, rect) ⇒ void
This method returns an undefined value.
Draw the background and chrome for a Wx::RBN::RibbonGallery control.
This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.
1681 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1681 def draw_gallery_background(dc, wnd, rect) end |
#draw_gallery_item_background(dc, wnd, rect, item) ⇒ void
This method returns an undefined value.
Draw the background of a single item in a Wx::RBN::RibbonGallery control.
This is painted on top of a gallery background, and behind the items bitmap. Unlike #draw_button_bar_button and #draw_tool, it is not expected to draw the item bitmap - that is done by the gallery control itself.
1691 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1691 def draw_gallery_item_background(dc, wnd, rect, item) end |
#draw_minimised_panel(dc, wnd, rect, bitmap) ⇒ void
This method returns an undefined value.
Draw a minimised ribbon panel.
1672 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1672 def draw_minimised_panel(dc, wnd, rect, bitmap) end |
#draw_page_background(dc, wnd, rect) ⇒ void
This method returns an undefined value.
Draw the background of a ribbon page.
1654 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1654 def draw_page_background(dc, wnd, rect) end |
#draw_panel_background(dc, wnd, rect) ⇒ void
This method returns an undefined value.
Draw the background and chrome for a ribbon panel.
This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel. Note that when a panel is minimised, this function is not called - only #draw_minimised_panel is called, so a background should be explicitly painted by that if required.
1664 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1664 def draw_panel_background(dc, wnd, rect) end |
#draw_scroll_button(dc, wnd, rect, style) ⇒ void
This method returns an undefined value.
Draw a ribbon-style scroll button.
1571 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1571 def (dc, wnd, rect, style) end |
#draw_tab(dc, wnd, tab) ⇒ void
This method returns an undefined value.
Draw a single tab in the tab region of a ribbon bar.
1636 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1636 def draw_tab(dc, wnd, tab) end |
#draw_tab_ctrl_background(dc, wnd, rect) ⇒ void
This method returns an undefined value.
Draw the background of the tab region of a ribbon bar.
1610 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1610 def draw_tab_ctrl_background(dc, wnd, rect) end |
#draw_tab_separator(dc, wnd, rect, visibility) ⇒ void
This method returns an undefined value.
Draw a separator between two tabs in a ribbon bar.
1644 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1644 def draw_tab_separator(dc, wnd, rect, visibility) end |
#draw_tool(dc, wnd, rect, bitmap, kind, state) ⇒ void
This method returns an undefined value.
Draw a single tool (for a Wx::RBN::RibbonToolBar control).
1734 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1734 def draw_tool(dc, wnd, rect, bitmap, kind, state) end |
#draw_tool_bar_background(dc, wnd, rect) ⇒ void
This method returns an undefined value.
Draw the background for a Wx::RBN::RibbonToolBar control.
1717 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1717 def (dc, wnd, rect) end |
#draw_tool_group_background(dc, wnd, rect) ⇒ void
This method returns an undefined value.
Draw the background for a group of tools on a Wx::RBN::RibbonToolBar control.
1724 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1724 def draw_tool_group_background(dc, wnd, rect) end |
#get_bar_tab_width(dc, wnd, label, bitmap) ⇒ Array(Integer,Integer,Integer,Integer) Also known as: bar_tab_width
Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
1628 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1628 def (dc, wnd, label, bitmap) end |
#get_colour(id) ⇒ Wx::Colour Also known as: colour
Get the value of a certain colour setting.
id can be one of the colour values of Wx::RBN::RibbonArtSetting.
1525 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1525 def get_colour(id) end |
#get_panel_client_size(dc, wnd, size, client_offset) ⇒ Wx::Size Also known as: panel_client_size
Calculate the client size of a panel for a given overall size.
This should act as the inverse to #get_panel_size, and decrement the given size by enough to fit the panel label and other chrome.
1594 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1594 def get_panel_client_size(dc, wnd, size, client_offset) end |
#get_panel_ext_button_area(dc, wnd, rect) ⇒ Wx::Rect Also known as:
Calculate the position and size of the panel extension button.
1602 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1602 def (dc, wnd, rect) end |
#get_panel_size(dc, wnd, client_size, client_offset) ⇒ Wx::Size Also known as: panel_size
Calculate the size of a panel for a given client size.
This should increment the given size by enough to fit the panel label and other chrome.
1582 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1582 def get_panel_size(dc, wnd, client_size, client_offset) end |
#get_scroll_button_minimum_size(dc, wnd, style) ⇒ Wx::Size Also known as:
Calculate the minimum size (in pixels) of a scroll button.
1562 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1562 def (dc, wnd, style) end |
#get_tab_ctrl_height(dc, wnd, pages) ⇒ Integer Also known as: tab_ctrl_height
Calculate the height (in pixels) of the tab region of a ribbon bar.
Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.
1619 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1619 def get_tab_ctrl_height(dc, wnd, pages) end |
#set_colour(id, colour) ⇒ void
This method returns an undefined value.
Set the value of a certain colour setting to the value colour.
id can be one of the colour values of Wx::RBN::RibbonArtSetting, though not all colour settings will have an effect on every art provider.
1535 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1535 def set_colour(id, colour) end |
#set_colour_scheme(primary, secondary, tertiary) ⇒ void
This method returns an undefined value.
Set all applicable colour settings from a few base colours.
Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.
1547 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1547 def set_colour_scheme(primary, secondary, tertiary) end |
#set_font(id, font) ⇒ void
This method returns an undefined value.
Set the value of a certain font setting to the value font.
id can be one of the font values of Wx::RBN::RibbonArtSetting.
1555 |
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1555 def set_font(id, font) end |