Class Background
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
The Background is a widget that use for setting (solid) background decorations to a window (unless it has transparency enabled) or to any container object.
C#Copy[Obsolete("This has been deprecated in API12")] public class Background : Layout, IAccessibleObject
- Inheritance
- Implements
Constructors
Declaration
C#Copy[Obsolete("This has been deprecated in API12")] public Background(EvasObject parent)
Parameters
| Type | Name | Description |
|---|---|---|
| EvasObject | parent | The EvasObject to which the new background will be attached as a child. |
Properties
BackgroundOption
Sets or gets the mode of display for a given background widget's image.
Declaration
C#Copy[Obsolete("This has been deprecated in API12")] public BackgroundOptions BackgroundOption { get; set; }
Property Value
| Type | Description |
|---|---|
| BackgroundOptions |
Remarks
This sets how the background widget will display its image. This will only work if the file was previously set with an image file on object. The image can be display tiled, scaled, centered, or stretched. Scaled by default.
Declaration
C#Copy[Obsolete("This has been deprecated in API12")] public override Color Color { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
Overrides
Declaration
C#Copy[Obsolete("This has been deprecated in API12")] public string File { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
Declaration
C#Copy[Obsolete("This has been deprecated in API12")] protected override IntPtr CreateHandle(EvasObject parent)
Parameters
| Type | Name | Description |
|---|---|---|
| EvasObject | parent | Parent EvasObject. |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Handle IntPtr. |
Overrides
SetFileLoadSize(int, int)
Sets the size of the pixmap representation of the image set on a given background widget. This method just makes sense if an image file was set. This is just a hint for the underlying system. The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested.
Declaration
C#Copy[Obsolete("This has been deprecated in API12")] public void SetFileLoadSize(int w, int h)
Parameters
| Type | Name | Description |
|---|---|---|
| int | w | The new width of the image pixmap representation. |
| int | h | The new height of the image pixmap representation. |