Skip to content

Latest commit

 

History

History
48 lines (46 loc) · 4.03 KB

migration_guide_3_to_4.rst

File metadata and controls

48 lines (46 loc) · 4.03 KB
Raw

Migration Guide - v3 to v4

  • pygame_menu v4 no longer python 2.7 to 3.5.
  • VMargin widget now updates it's height rather than modifying the margin.
  • Added __all__ to module, then some usage cases importing with * may fail.
  • All locals inner value have changed. If you used the value as-is you'll get an error.
  • BaseImage applies smooth by default, also rotation applies on checkpointed surface.
  • Menu add_button, add_color_input, add_image, add_label, add_selector, add_text_input, add_vertical_margin and add_generic_widget were moved to WidgetManager class.
  • Menu add_image method parameter scale_smooth is now True by default.
  • Menu clear method now receives reset optional argument.
  • Menu mainloop, update and draw now raises RuntimeError if it's disabled. This behaviour can be changed though Menu private property _runtime_errors.
  • Menu column/row positioning has changed, now column_max_width has a different behaviour. For setting the minimum width of columns use column_min_width. Expect some minor changes to the global layout. Now is much more consistent.
  • Menu constructor changed from Menu(height, width, title, ...) to Menu(title, width, height, ...).
  • Menu method get_width() changes toget_width(inner=False, widget=False).
  • Moved previsualization_width colorinput method to kwargs.
  • Removed column_force_fit_text from Menu constructor. Use Widget set_max_width or set_max_height instead.
  • Removed dummy_function from pygame_menu.utils.
  • Removed events.DISABLE_CLOSE, use None or events.NONE instead.
  • Removed Widget method surface_needs_update(). Now use method force_menu_surface_update if needed.
  • Renamed ColorInput constants TYPE_HEX, TYPE_RGB, HEX_FORMAT_LOWER, HEX_FORMAT_NONE, and HEX_FORMAT_UPPER, to COLORINPUT_*.
  • Renamed touchscreen_enabled to touchscreen in Menu constructor.
  • Renamed Widget method from set_selected(selected=True) to select(status=True, update_menu=False).
  • Renamed Menu constructor parameter menu_position to position.
  • Renamed Selector elements to items.
  • Renamed Selector update_elements to update_items.
  • Renamed Theme menubar_close_button to title_close_button.
  • Renamed Theme title_shadow_color to title_font_shadow_color.
  • Renamed Theme title_shadow_offset to title_font_shadow_offset.
  • Renamed Theme title_shadow_position` totitle_font_shadow_position``.
  • Renamed Theme title_shadow to title_font_shadow.
  • Renamed Theme widget_shadow_color to widget_font_shadow_color.
  • Renamed Theme widget_shadow_offset to widget_font_shadow_offset.
  • Renamed Theme widget_shadow_position` towidget_font_shadow_position``.
  • Renamed Theme widget_shadow to widget_font_shadow.
  • Renamed Widget _force_menu_surface_update method to force_menu_surface_update.
  • Renamed Widget _force_menu_surface_update method to force_menu_surface_update.
  • Renamed Widget expand_background_inflate_to_selection_effect method to background_inflate_to_selection_effect.
  • Widget selected property is now private. Use is_selected() to check selection status, and select(...) to modify it.
  • Widget shadow_offset now cannot be None or float, only int allowed.
  • Widget sound property is now private. Use .get_sound() or .set_sound().
  • Widget visible property is now private. Use .is_visible() to check visibility status, and .show() or .hide() to modify it.
  • Widget VMargin now inherits from NoneWidget.
  • Widget properties joystick_enabled, mouse_enabled, touchscreen_enabled and sound are now private.
  • WidgetManager methods renamed shadow to font_shadow for each shadow-related optional arguments.
  • Widgets now must define only _draw, draw() is reserved to Widget core class only.