View source

=Background Image for UNO AWT dialogs and tabpages =

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"

|- align="left"
| colspan="2" bgcolor="#cccccc"   | '''Specification Status''' 
|-
| width="150" | '''Author''' || Carsten Driesner
|-
| width="150" | '''Last Change''' || 09.11.2007
|-
| width="150" | '''Status''' || Preliminary
|-
|}

== Abstract ==

The UNO awt library should support to set a background image for dialogs and tab pages to create a more attractive user interface.
__TOC__

== References ==

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
|-
| width="300" bgcolor="#dddddd" | '''Reference Document''' || bgcolor="#dddddd" | '''Check''' || bgcolor="#dddddd" | '''Location (URL)'''
|-
| |'''[http://wiki.services.openoffice.org/wiki/Category:Specification#Before_Writing_a_Software_Specification_--_What_Else_Do_I_have_to_Do.3F Specification Process Entry Check]'''
| [passed]
| n/a
|-
| '''Product Requirement, RFE, Issue ID''' (required)
| [available]
| https://so-web.germany.sun.com/iBIS/servlet/edit.ControlPanel?tid=i83238
|-
| Product Concept Document
| [not available]
| -
|-
| '''[[Test case specification]]''' (required)
| [available/not available]
| <PLEASE ENTER LOCATION HERE>
|-
| IDL Specification
| [available/not available]
| <PLEASE ENTER LOCATION HERE>
|-
| [http://wiki.services.openoffice.org/wiki/The_Three_Golden_Rules_for_Writing_OpenOffice.org_Specifications '''Software Specification Rules''']
| n/a
| n/a
|-
| Other, e.g. references to related specs
|
| <PLEASE ENTER LOCATION HERE>
|-
|}

== Contacts ==

{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
|-
| width="300" bgcolor="#dddddd" | '''Role''' || bgcolor="#dddddd" | '''Name''' || bgcolor="#dddddd" | '''E-Mail Address'''
|-
| '''Developer'''
| Carsten Driesner
| cd@openoffice.org
|-
| '''Quality Assurance'''
| Jörg Skottke
| jsk@openoffice.org
|-
| '''Documentation'''
| Uwe Fischer
| ufi@openoffice.org
|-
| '''User Experience'''
| <First Name, Last Name>
| <User@openoffice.org>
|-
|}

== Acronyms and Abbreviations ==
{| border="2" cellpadding="4" cellspacing="0" style="margin: 1em 1em 1em 0;  border: 1px #cccccc solid; border-collapse: collapse; width: 100%"
|-
| bgcolor="#dddddd" | '''Acronym / Abbreviation''' || bgcolor="#dddddd" | '''Definition'''
|-
| property
| A value with a type which represents a specific state. Normally addressed by a unique name.
|-
|}

== Detailed Specification ==

The UNO awt library should be extended to support a new property for dialogs and tab pages. The property contains the URL for an image that is displayed in the background of a dialog or tab page. Developers would be able to make their dialogs or tab pages more attractive to users.

To accomplish the task two new properties were added to the '''com.sun.star.awt.UnoControlDialogModel'''. You can see the name and type of the properties below.

<code>[cpp]
/** specifies a URL that references a graphic that should be used as a
    background image.
    @see Graphic

    @since OOo 2.4.0
*/
[optional, property] string ImageURL;

/** specifies a graphic to be displayed as a background image

    <p>If this property is present, it interacts with the <member>ImageURL</member>in the
       following way:
       <ul><li>If <member>ImageURL</member> is set, <member>Graphic</member> will be reset
            to an object as loaded from the given image URL, or <NULL/> if <member>ImageURL</member>
            does not point to a valid image file.</li>
           <li>If <member>Graphic</member> is set, <member>ImageURL</member> will be reset
            to an empty string.</li>
       </ul></p>

    @since OOo 2.4.0
*/
[optional, property, transient] com::sun::star::graphic::XGraphic Graphic;
</code>

The property browser for dialogs and tab pages is extended to select an image file via a file selection dialog.

[[image:TabPage_PropertyBrowser.PNG]]

When the user selects an image file for the tab page or dialog the background will be painted with the selected image.

[[image:TabPage_With_Bitmap_Wallpaper.PNG]]

The controls which reside in the tab page or dialog will be transparent when the background color is set to default. Otherwise the would use their own background color.

[[image:Dialog_With_Background_Bitmap.PNG]]

The new property called "Graphics" is not completely new as some controls already support to set an image (e.g. radio button, image control). Therefore no new strings will be added, resulting in no additional translation work.

 [[Specification_Template_Help#Detailed_Specification|Help]] | [[UI-Elements|User Interface Element Templates]] | [[Specification_Example|Example Spec]]

== Migration ==

There is no migration necessary for this enhancement.

== Configuration ==
There are no configuration items involved.

 [[Specification_Template_Help#Configuration|Help]] | [[Configuration-Table|Configuration Table Template]]

== File Format ==
There are no changes to the file format necessary.

 [[Specification_Template_Help#File Format|Help]] | [[File Format Table|File Format Table Template]]

== Open Issues ==
<State a bulleted list of issues Issue here>

[[Category:Specification]]