Class: Wx::RBN::RibbonAUIArtProvider

Inherits:
RibbonMSWArtProvider show all
Defined in:
lib/wx/doc/gen/rbn/ribbon_art_provider.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

Requires:

  • USE_RIBBON

Instance Method Summary collapse

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

#initializeWx::RBN::RibbonAUIArtProvider



1514
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1514

def initialize; end

Instance Method Details

#cloneWx::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.

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::Window)

    The window which is being drawn onto (which will typically be the button bar itself, though this is not guaranteed).

  • rect (Wx::Rect)

    The rectangle within which to draw.



1698
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1698

def draw_button_bar_background(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.

Parameters:



1710
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1710

def draw_button_bar_button(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small) end

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.

Parameters:



1681
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1681

def draw_gallery_background(dc, wnd, rect) end

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.

Parameters:



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.

Parameters:



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.

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::Window)

    The window which is being drawn onto (which is commonly the Wx::RBN::RibbonPage whose background is being drawn, but doesn’t have to be).

  • rect (Wx::Rect)

    The rectangle within which to draw.

See Also:

  • GetPageBackgroundRedrawArea


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.

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::RBN::RibbonPanel)

    The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this.

  • rect (Wx::Rect)

    The rectangle within which to draw.



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.

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::Window)

    The window which is being drawn onto.

  • rect (Wx::Rect)

    The rectangle within which to draw. The size of this rectangle will be at least the size returned by #get_scroll_button_minimum_size for a scroll button with the same style. For tab scroll buttons, this rectangle will be entirely within a rectangle on the same device context previously painted with #draw_tab_ctrl_background, but this is not guaranteed for other types of button (for example, page scroll buttons will not be painted on an area previously painted with #draw_page_background).

  • style (Integer)

    A combination of flags from Wx::RBN::RibbonScrollButtonStyle, including a direction, a for flag, and one or more states.



1571
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1571

def draw_scroll_button(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.

Parameters:



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.

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::Window)

    The window which is being drawn onto.

  • rect (Wx::Rect)

    The rectangle within which to draw.



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.

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::Window)

    The window which is being drawn onto.

  • rect (Wx::Rect)

    The rectangle within which to draw, which will be entirely within a rectangle on the same device context previously painted with #draw_tab_ctrl_background.

  • visibility (Float)

    The opacity with which to draw the separator. Values are in the range [0, 1], with 0 being totally transparent, and 1 being totally opaque.



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).

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::Window)

    The window which is being drawn onto. In most cases this will be a Wx::RBN::RibbonToolBar, but it doesn’t have to be.

  • rect (Wx::Rect)

    The rectangle within which to draw. The size of this rectangle will at least the size returned by Wx::RBN::RibbonMSWArtProvider#get_tool_size, and the height of it will be equal for all tools within the same group. The rectangle will be entirely within a rectangle on the same device context previously painted with #draw_tool_group_background.

  • bitmap (Wx::Bitmap)

    The bitmap to use as the tool’s foreground. If the tool is a hybrid or dropdown tool, then the foreground should also contain a standard dropdown button.

  • kind (Wx::RibbonButtonKind)

    The kind of tool to draw (normal, dropdown, or hybrid).

  • state (Integer)

    A combination of Wx::RibbonToolBarToolState flags giving the state of the tool and it’s relative position within a tool group.



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.

Parameters:



1717
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1717

def draw_tool_bar_background(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.

Parameters:

  • dc (Wx::DC)

    The device context to draw onto.

  • wnd (Wx::Window)

    The window which is being drawn onto. In most cases this will be a Wx::RBN::RibbonToolBar, but it doesn’t have to be.

  • rect (Wx::Rect)

    The rectangle within which to draw. This rectangle is a union of the individual tools’ rectangles. As there are no gaps between tools, this rectangle will be painted over exactly once by calls to #draw_tool. The group background could therefore be painted by #draw_tool, though it can be conceptually easier and more efficient to draw it all at once here. The rectangle will be entirely within a rectangle on the same device context previously painted with #draw_tool_bar_background.



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.

Parameters:

  • dc (Wx::DC)

    A device context to use when one is required for size calculations.

  • wnd (Wx::Window)

    The window onto which the tab will eventually be drawn.

  • label (String)

    The tab’s label (or EmptyString if it has none).

  • bitmap (Wx::Bitmap)

    The tab’s icon (or NULL_BITMAP if it has none).

Returns:

  • (Array(Integer,Integer,Integer,Integer))


1628
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1628

def get_bar_tab_width(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.

Parameters:

  • id (Integer)

Returns:



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.

Parameters:

  • dc (Wx::DC)

    A device context to use if one is required for size calculations.

  • wnd (Wx::RBN::RibbonPanel)

    The ribbon panel in question.

  • size (Wx::Size)

    The overall size to calculate client size for.

  • client_offset (Wx::Point)

    The offset where the returned client size begins within the given size (may be NULL).

Returns:

See Also:



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: panel_ext_button_area

Calculate the position and size of the panel extension button.

Parameters:

  • dc (Wx::DC)

    A device context to use if one is required for size calculations.

  • wnd (Wx::RBN::RibbonPanel)

    The ribbon panel in question.

  • rect (Wx::Rect)

    The panel rectangle from which calculate extension button rectangle.

Returns:



1602
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1602

def get_panel_ext_button_area(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.

Parameters:

  • dc (Wx::DC)

    A device context to use if one is required for size calculations.

  • wnd (Wx::RBN::RibbonPanel)

    The ribbon panel in question.

  • client_size (Wx::Size)

    The client size.

  • client_offset (Wx::Point)

    The offset where the client rectangle begins within the panel (may be NULL).

Returns:

See Also:



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: scroll_button_minimum_size

Calculate the minimum size (in pixels) of a scroll button.

Parameters:

  • dc (Wx::DC)

    A device context to use when one is required for size calculations.

  • wnd (Wx::Window)

    The window onto which the scroll button will eventually be drawn.

  • style (Integer)

    A combination of flags from Wx::RBN::RibbonScrollButtonStyle, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).

Returns:



1562
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1562

def get_scroll_button_minimum_size(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.

Parameters:

  • dc (Wx::DC)

    A device context to use when one is required for size calculations.

  • wnd (Wx::Window)

    The window onto which the tabs will eventually be drawn.

  • pages (Array<Wx::RBN::RibbonPageTabInfo>)

    The tabs which will acquire the returned height.

Returns:

  • (Integer)


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.

Parameters:

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

See Also:



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.

Parameters:

See Also:



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.

Parameters:



1555
# File 'lib/wx/doc/gen/rbn/ribbon_art_provider.rb', line 1555

def set_font(id, font) end