User:Hanya/API Changes on 4.0 since 3.4
There are some API changes applied to Apache OpenOffice 4.0 since version 3.4.
Contents
Impact
The impact of these changes are influence differently over your code.
- C++: recompilation required because of stlport removal.
- Java: should be migrated and recompiled.
- Basic or Python: should be migrated.
Message box
Message box APIs were cleaned up. See issue 121544.
- com.sun.star.awt.XMessageBoxFactory
- createMessageBox method
- second argument that specifiy size of the box was removed, it was not used.
- third argument that specify the type of the icon shown in the box is changed from string to com.sun.star.awt.MessageBoxType, see below.
- createMessageBox method
- com.sun.star.awt.XMessageBox
- setCaptionText, getCaptionText, setMessageText, getMessageText methods were changed to corresponding attributes.
- return value of execute method was defined in com.sun.star.awt.MessageBoxResults, see below.
- No longer deprecated.
- com.sun.star.awt.MessageBoxType
- Member of this enumerated value can be used to specify type of the message box.
- com.sun.star.awt.MessageBoxResults
- Member of this constants group can be used to check the result of the execution of the message box. Renamed from MessageBoxCommand. And IGNORE member was added.
- com.sun.star.awt.MessageBoxCommand
- Renamed to MessageBoxResults.
Menu
Menu APIs were integrated. See issue 121542.
- com.sun.star.awt.XMenuBarExtended
- Integrated into other interfaces, this interface is used to integrate some menu interfaces without any methods.
- com.sun.star.awt.XMenuExtended
- getCommand, getCommand, setHelpCommand and getHelpCommmand methods are moved into com.sun.star.awt.XMenu interface.
- com.sun.star.awt.XMenuExtended2
- isPopupMenu, clear, getItemType, hideDisableEntries methods are moved into com.sun.star.awt.XMenu interface.
- com.sun.star.awt.XPopupMenuExtended
- isInExecute, endExecute, setAcceleratorKeyEvent, getAcceleratorKeyEvent, setItemImage and getItemImage methods were moved into com.sun.star.awt.XPopupMenu interface.
- setHelpText, getHelpText, setTipHelpText and getTipHelpText methods were moved into com.sun.star.awt.XMenu interface.
- setItemImageAngle, getItemImageAngle, setItemImageMirrorMode and isItemImageInMirrorMode methods were removed.
- com.sun.star.awt.XPopupMenu
- Some methods were moved from each interfaces described above to this interface.
- com.sun.star.awt.XMenu
- Some methods were moved from each interfaces to this interface.
- com.sun.star.awt.XMenuListener
- The following method names were changed.
- highlight -> itemHighlighted
- select -> itemSelected
- activate -> itemActivated
- deactivate -> itemDeactivated
- The following method names were changed.
- com.sun.star.awt.MenuItemStyle
- Unpublished, no changes in the members.
- com.sun.star.awt.PopupMenuDirection
- deprecated members were removed.
- com.sun.star.awt.MenuLogo
- Removed. See issue 121542.
Controls
com.sun.star.awt.UnoControlThrobberModel was replaced with com.sun.star.awt.SpinningProgressControlModel. See issue 121513.
- com.sun.star.awt.UnoControlThrobber
- com.sun.star.awt.UnoControlThrobberModel
- com.sun.star.awt.XThrobber
- Please use com.sun.star.awt.AnimatedImagesControl control with com.sun.star.awt.SpinningProgressControlModel.
com.sun.star.awt.UnoControlSimpleAnimation control was replaced with com.sun.star.awt.AnimatedImagesControl.
- com.sun.star.awt.UnoControlSimpleAnimation
- com.sun.star.awt.UnoControlSimpleAnimationModel
- com.sun.star.awt.XSimpleAnimation
- Please use com.sun.star.awt.AnimatedImagesControl. issue 121514.
com.sun.star.awt Module
Graphics APIs were cleaned up. See issue 121442.
- com.sun.star.awt.XGraphics
- getDevice, getFontMetric, setFont, setTextColor, setTextFillColor, setLineColor, setFillColor, setRasterOp methods were changed to corresponding attributes.
- clear and drawImage methods were added.
- com.sun.star.awt.ImageDrawMode
- Added. Constants are used to specify the mode in com.sun.star.awt.XGraphics::drawImage method.
- com.sun.star.awt.ImageScaleMode
- Member names were corrected to be uppercase.
- com.sun.star.awt.PrinterServer
- This service was converted into new style service with constructor.
System
Clean-up system mail API. See issue 121579.
- com.sun.star.system.SimpleCommandMail
- com.sun.star.system.SimpleMailClientFlags
- com.sun.star.system.SimpleSystemMail
- com.sun.star.system.XMailClient
- com.sun.star.system.XMailMessage
- com.sun.star.system.XSimpleMailClient
- com.sun.star.system.XSimpleMailClientSupplier
- com.sun.star.system.XSimpleMailMessage
- com.sun.star.system.XSystemMailProvider
- com.sun.star.system.SimpleMailClientFlags
- Removed. See below.
- com.sun.star.system.SystemMailProvider
- System dependent mail services were integrated into com.sun.star.system.SystemMailProvider.
Remove deprecated system proxy API. See issue 121548.
- com.sun.star.system.MailClientFlags
- Renamed from SimpleMailClientFlags.
- com.sun.star.system.ProxySettings
- com.sun.star.system.XProxySettings
- com.sun.star.system.SystemProxySettings
- com.sun.star.system.SOffice52ProxySettings
- No longer used, removed.
- com.sun.star.system.SystemShellExecute
- This service was converted to new style service with a constructor.
com.sun.star.text Module
- com.sun.star.text.AutoTextGroup
- FilePath and Title properties were added for documenting. See issue 87780.
- com.sun.star.text.ViewSettings
- ShowContentTips and ShowScrollBarTips properties were added. See issue 25945.
com.sun.star.frame Module
- com.sun.star.frame.PopupMenuControllerFactory
- com.sun.star.frame.StatusbarControllerFactory
- These services were converted to new style service with constructors.
- com.sun.star.frame.ToolbarControllerFactory
- com.sun.star.frame.XUIControllerFactory
- Added.
- com.sun.star.frame.XStatusbarController
- click and doubleClick methods takes an argument.
Sidebar
See issue 121420.
- com.sun.star.ui.ContextChangeEventMultiplexer
- com.sun.star.ui.ContextChangeEventObject
- com.sun.star.ui.XContextChangeEventMultiplexer
- com.sun.star.ui.XContextChangeEventListener
- com.sun.star.ui.XSidebar
- com.sun.star.ui.XSidebarPanel
- com.sun.star.ui.LayoutSize
- com.sun.star.util.EventMultiplexer
- Added. They are used in the sidebar.
UCB
- com.sun.star.ucb.Content
- addProperty and removeProperty commands were added. See issue 121935.
- com.sun.star.ucb.PropertyCommandArgument
- Added. Argument for the new commands.
- com.sun.star.ucb.XWebDAVCommandEnvironment
- Request method is specified by WebDAVHTTPMethod, see below.
- com.sun.star.ucb.WebDAVHTTPMethod
- Added. Request methods were defined in WebDAVHTTPMethod.
SmartTag
Make smarttag function more powrful.
See issue 121391, 121730, 121731, 121732, 121733, 121734 and http://mail-archives.apache.org/mod_mbox/openoffice-dev/201302.mbox/browser .
- com.sun.star.smarttags.XRangeBasedSmartTagRecognizer
- Added.
- com.sun.star.smarttags.XSmartTagAction
- getActionCount method takes additional parameter.
- com.sun.star.text.XMarkingAccess
- com.sun.star.container.XNamedEx
- Added.
- com.sun.star.text.XTextMarkup
- commitTextMarkup method was renamed to commitStringMarkup
- commitTextRangeMarkup method was added.
Calc
See issue 120478.
- com.sun.star.sheet.XNamedRange2
- com.sun.star.sheet.XNamedRanges2
- com.sun.star.sheet.RangeScopeName
- Added.
Other
- com.sun.star.configuration.BootstrapContext
- Deprecated. See issue 118815.
- com.sun.star.ui.XStatusbarItem
- Added. See issue 121442.