Class: Wx::RBN::RibbonArtProvider

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

Overview

RibbonArtProvider is responsible for drawing all the components of the ribbon interface.

This allows a ribbon bar to have a pluggable look-and-feel, while retaining the same underlying behaviour. As a single art provider is used for all ribbon components, a ribbon bar usually has a consistent (though unique) appearance. By default, a RibbonBar uses an instance of this class called RibbonDefaultArtProvider, which resolves to RibbonAUIArtProvider, RibbonMSWArtProvider, or Wx::RibbonOSXArtProvider - whichever is most appropriate to the current platform. These art providers are all slightly configurable with regard to colours and fonts, but for larger modifications, you can derive from one of these classes, or write a completely new art provider class. Call Wx::RBN::RibbonBar#set_art_provider to change the art provider being used.

Category: Ribbon User Interface

See Also:

Requires:

  • USE_RIBBON

Direct Known Subclasses

RibbonMSWArtProvider

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Wx::RBN::RibbonArtProvider

Constructor.



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

def initialize; end

Instance Method Details

#clone ⇒ Wx::RBN::RibbonArtProvider

Create a new art provider which is a clone of this one.

Returns:



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

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.



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

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:



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

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

Parameters:



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

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.

Parameters:



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

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

#draw_help_button(dc, wnd, rect) ⇒ void

This method returns an undefined value.

Draw help button on Wx::RBN::RibbonBar.

This should draw a help button at top right corner of ribbon bar.

Parameters:

  • dc (Wx::DC) —

    The device context to draw onto.

  • wnd (Wx::RBN::RibbonBar) —

    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.



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

def draw_help_button(dc, wnd, rect) end

#draw_minimised_panel(dc, wnd, rect, bitmap) ⇒ void

This method returns an undefined value.

Draw a minimised ribbon panel.

Parameters:



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

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


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

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.



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

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.



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

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:



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

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.



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

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.



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

def draw_tab_separator(dc, wnd, rect, visibility) end

#draw_toggle_button(dc, wnd, rect, mode) ⇒ void

This method returns an undefined value.

Draw toggle button on Wx::RBN::RibbonBar.

This should draw a small toggle button at top right corner of ribbon bar.

Parameters:

  • dc (Wx::DC) —

    The device context to draw onto.

  • wnd (Wx::RBN::RibbonBar) —

    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.

  • mode (Wx::RibbonDisplayMode) —

    The Wx::RBN::RibbonDisplayMode which should be applied to display button



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

def draw_toggle_button(dc, wnd, rect, mode) 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 #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.



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

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:



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

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.



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

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


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

def get_bar_tab_width(dc, wnd, label, bitmap) end

#get_bar_toggle_button_area(rect) ⇒ Wx::Rect Also known as: bar_toggle_button_area

Calculate the position and size of the ribbon’s toggle button.

Parameters:

  • rect (Wx::Rect) —

    The ribbon bar rectangle from which calculate toggle button rectangle.

Returns:



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

def get_bar_toggle_button_area(rect) end

#get_button_bar_button_size(dc, wnd, kind, size, label, text_min_width, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) ⇒ Boolean Also known as: button_bar_button_size

Calculate the size of a button within a Wx::RBN::RibbonButtonBar.

true if a size exists for the button, false otherwise.

Parameters:

Returns:

  • (Boolean) 


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

def get_button_bar_button_size(dc, wnd, kind, size, label, text_min_width, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) end

#get_button_bar_button_text_width(dc, label, kind, size) ⇒ Integer Also known as: button_bar_button_text_width

Gets the width of the string if it is used as a Wx::RBN::RibbonButtonBar button label.

Width of the given label text in pixel.

Note:

This function only works with single-line strings.

Parameters:

Returns:

  • (Integer) 


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

def get_button_bar_button_text_width(dc, label, kind, size) end

#get_color(id) ⇒ Wx::Colour Also known as: color

Parameters:

  • id (Integer)

Returns:

See Also:



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

def get_color(id) 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:



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

def get_colour(id) end

#get_colour_scheme(primary, secondary, tertiary) ⇒ void Also known as: colour_scheme

This method returns an undefined value.

Get the current colour scheme.

Returns three colours such that if #set_colour_scheme were called with them, the colour scheme would be restored to what it was when #set_colour_scheme was last called. In practice, this usually means that the returned values are the three colours given in the last call to #set_colour_scheme, however if #set_colour_scheme performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to #set_colour_scheme. If #set_colour_scheme has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if #set_colour is called, then #get_colour_scheme does not try and return a colour scheme similar to colours being used - it’s return values are dependent upon the last values given to #set_colour_scheme, as described above.

Parameters:

  • primary (Wx::Colour) —

    Pointer to a location to store the primary colour, or NULL.

  • secondary (Wx::Colour) —

    Pointer to a location to store the secondary colour, or NULL.

  • tertiary (Wx::Colour) —

    Pointer to a location to store the tertiary colour, or NULL.



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

def get_colour_scheme(primary, secondary, tertiary) end

#get_flags ⇒ Integer Also known as: flags

Get the previously set style flags.

Returns:

  • (Integer) 


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

def get_flags; end

#get_font(id) ⇒ Wx::Font Also known as: font

Get the value of a certain font setting.

id can be one of the font values of Wx::RBN::RibbonArtSetting.

Parameters:

  • id (Integer)

Returns:



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

def get_font(id) end

#get_gallery_client_size(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) ⇒ Wx::Size Also known as: gallery_client_size

Calculate the client size of a Wx::RBN::RibbonGallery control for a given size.

This should act as the inverse to #get_gallery_size, and decrement the given size by enough to fit the gallery border, buttons, and other chrome.

Parameters:

  • dc (Wx::DC) —

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

  • wnd (Wx::RBN::RibbonGallery) —

    The gallery in question.

  • size (Wx::Size) —

    The overall size to calculate the client size for.

  • client_offset (Wx::Point) —

    The position within the given size at which the returned client size begins.

  • scroll_up_button (Wx::Rect) —

    The rectangle within the given size which the scroll up button occupies.

  • scroll_down_button (Wx::Rect) —

    The rectangle within the given size which the scroll down button occupies.

  • extension_button (Wx::Rect) —

    The rectangle within the given size which the extension button occupies.

Returns:



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

def get_gallery_client_size(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) end

#get_gallery_size(dc, wnd, client_size) ⇒ Wx::Size Also known as: gallery_size

Calculate the size of a Wx::RBN::RibbonGallery control for a given client size.

This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.

Parameters:

  • dc (Wx::DC) —

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

  • wnd (Wx::RBN::RibbonGallery) —

    The gallery in question.

  • client_size (Wx::Size) —

    The client size.

Returns:

See Also:



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

def get_gallery_size(dc, wnd, client_size) end

#get_metric(id) ⇒ Integer Also known as: metric

Get the value of a certain integer setting.

id can be one of the size values of Wx::RBN::RibbonArtSetting.

Parameters:

  • id (Integer)

Returns:

  • (Integer) 


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

def get_metric(id) end

#get_minimised_panel_minimum_size(dc, wnd, desired_bitmap_size) ⇒ Array(Wx::Size,Wx::Direction) Also known as: minimised_panel_minimum_size

Calculate the size of a minimised ribbon panel.

Parameters:

  • dc (Wx::DC) —

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

  • wnd (Wx::RBN::RibbonPanel) —

    The ribbon panel in question. Attributes like the panel label can be queried from this.

  • desired_bitmap_size (Wx::Size) —

    Optional parameter which is filled with the size of the bitmap suitable for a minimised ribbon panel.

Returns:



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

def get_minimised_panel_minimum_size(dc, wnd, desired_bitmap_size) end

#get_page_background_redraw_area(dc, wnd, page_old_size, page_new_size) ⇒ Wx::Rect Also known as: page_background_redraw_area

Calculate the portion of a page background which needs to be redrawn when a page is resized.

To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.

Parameters:

  • dc (Wx::DC) —

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

  • wnd (Wx::RBN::RibbonPage) —

    The page which is being resized.

  • page_old_size (Wx::Size) —

    The size of the page prior to the resize (which has already been painted).

  • page_new_size (Wx::Size) —

    The size of the page after the resize.

Returns:



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

def get_page_background_redraw_area(dc, wnd, page_old_size, page_new_size) 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:



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

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:



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

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:



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

def get_panel_size(dc, wnd, client_size, client_offset) end

#get_ribbon_help_button_area(rect) ⇒ Wx::Rect Also known as: ribbon_help_button_area

Calculate the position and size of the ribbon’s help button.

Parameters:

  • rect (Wx::Rect) —

    The ribbon bar rectangle from which calculate help button rectangle.

Returns:



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

def get_ribbon_help_button_area(rect) 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:



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

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) 


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

def get_tab_ctrl_height(dc, wnd, pages) end

#get_tool_size(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) ⇒ Wx::Size Also known as: tool_size

Calculate the size of a tool within a Wx::RBN::RibbonToolBar.

Parameters:

  • dc (Wx::DC) —

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

  • wnd (Wx::Window) —

    The window onto which the tool will eventually be drawn.

  • bitmap_size (Wx::Size) —

    The size of the tool’s foreground bitmap.

  • kind (Wx::RibbonButtonKind) —

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

  • is_first (Boolean) —

    true if the tool is the first within its group. false otherwise.

  • is_last (Boolean) —

    true if the tool is the last within its group. false otherwise.

  • dropdown_region (Wx::Rect) —

    For dropdown and hybrid tools, the region within the returned size which counts as the dropdown part.

Returns:



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

def get_tool_size(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) end

#set_color(id, color) ⇒ void

This method returns an undefined value.

Parameters:

See Also:



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

def set_color(id, color) 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:



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

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:



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

def set_colour_scheme(primary, secondary, tertiary) end

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

This method returns an undefined value.

Set the style flags.

Normally called automatically by Wx::RBN::RibbonBar#set_art_provider with the ribbon bar’s style flags, so that the art provider has the same flags as the bar which it is serving.

Parameters:

  • flags (Integer) 


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

def set_flags(flags) 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:



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

def set_font(id, font) end

#set_metric(id, new_val) ⇒ void

This method returns an undefined value.

Set the value of a certain integer setting to the value new_val.

id can be one of the size values of Wx::RBN::RibbonArtSetting.

Parameters:

  • id (Integer)
  • new_val (Integer) 


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

def set_metric(id, new_val) end