MyFrame.1x

Langue: en

Autres versions - même langue

Version: AfterStep v.2.2.4 (mandriva - 01/05/08)

Section: 1 (Commandes utilisateur)

Sommaire

NAME

MyFrame - defines how AfterStep should construct window's frame
 Look  Alignment flags  Bevel flags  MyBackground MyFrame MyStyle  Suported hints  Titlebar layout 

CONFIGURATION OPTIONS

MyFrame " frame_name "
frame_option
~MyFrame

Specifies the beginning of a frame definition. The frame can be referred to later by frame_name . ~MyFrame ends a frame definition.

North "pixmap_name"

Specifies the pixmap to be displayed in the top border of the window frame, if DecorateFrames is set.

East "pixmap_name"

Specifies the pixmap to be displayed in the right border of the window frame, if DecorateFrames is set.

South "pixmap_name"

Specifies the pixmap to be displayed in the bottom border of the window frame, if DecorateFrames is set.

West "pixmap_name"

Specifies the pixmap to be displayed in the left border of the window frame, if DecorateFrames is set.

NorthWest "pixmap_name"

Specifies the pixmap to be displayed in the top left corner of the window frame, if DecorateFrames is set.

NorthEast "pixmap_name"

Specifies the pixmap to be displayed in the top right corner of the window frame, if DecorateFrames is set.

SouthWest "pixmap_name"

Specifies the pixmap to be displayed in the bottom left corner of the window frame, if DecorateFrames is set.

SouthEast "pixmap_name"

Specifies the pixmap to be displayed in the bottom right corner of the window frame, if DecorateFrames is set.

Side [ South | North | East | West ] "pixmap_name"

Specifies the side of the window frame to be decorated and the pixmap to be used.

NoSide

FIXME: add proper description here.

Corner [ SouthEast | SouthWest | NorthEast | NorthWest ] "pixmap_name"

Specifies the corner of the window frame to be decorated and the pixmap to be used.

NoCorner

FIXME: add proper description here.

TitleUnfocusedStyle MyStyle

MyStyle to apply to titlebar if window is in unfocused state.

TitleUStyle MyStyle

Alias for TitleUnfocusedStyle.

TitleFocusedStyle MyStyle

MyStyle to apply to titlebar if window is in focused state.

TitleFStyle MyStyle

Alias for TitleFocusedStyle.

TitleStickyStyle MyStyle

MyStyle to apply to titlebar if window is in sticky state.

TitleSStyle MyStyle

Alias for TitleStickyStyle.

FrameUnfocusedStyle MyStyle

Defines the MyStyle to apply to the window frame if window is in unfocused state.

FrameUStyle MyStyle

Alias for FrameUnfocusedStyle.

FrameFocusedStyle MyStyle

Defines the MyStyle to apply to the window frame if window is in focused state.

FrameFStyle MyStyle

Alias for FrameFocusedStyle.

FrameStickyStyle MyStyle

Defines the MyStyle to apply to the window frame if window is in sticky state.

FrameSStyle MyStyle

Alias for FrameStickyStyle.

SideSize

FIXME: add proper description here.

SideAlign

FIXME: add proper description here.

See Also: Alignment flags for further details.

SideBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

SideFBevel

Alias for SideFBevel.

See Also: Bevel flags for further details.

SideUBevel

Alias for SideUnfocsedBevel.

See Also: Bevel flags for further details.

SideSBevel

Alias for SideStickyBevel.

See Also: Bevel flags for further details.

SideFocusedBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

SideUnfocusedBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

SideStickyBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

CornerSize NorthEast|SouthEast|NorthWest|SouthWest|Any WIDTHxHEIGHT

FIXME: add proper description here.

CornerAlign

FIXME: add proper description here.

See Also: Alignment flags for further details.

CornerBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

CornerFBevel

Alias for CornerFocusedBevel.

See Also: Bevel flags for further details.

CornerUBevel

Alias for CornerUnfocusedBevel.

See Also: Bevel flags for further details.

CornerSBevel

Alias for CornerStickyBevel.

See Also: Bevel flags for further details.

CornerFocusedBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

CornerUnfocusedBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

CornerStickyBevel NorthEast|SouthEast|NorthWest|SouthWest|Any None|[Left,Top,Right,Bottom,Extra,NoOutline]

FIXME: add proper description here.

See Also: Bevel flags for further details.

TitleBevel

FIXME: add proper description here.

See Also: Bevel flags for further details.

TitleFBevel

Alias for TitleFocusedBevel.

See Also: Bevel flags for further details.

TitleUBevel

Alias for TitleUnfocusedBevel.

See Also: Bevel flags for further details.

TitleSBevel

Alias for TitleStickyBevel.

See Also: Bevel flags for further details.

TitleFocusedBevel

Determines the bevel to be drawn around the title bar if window is in focused state.

See Also: Bevel flags for further details.

TitleUnfocusedBevel

Determines the bevel to be drawn around the title bar if window is in unfocused state.

See Also: Bevel flags for further details.

TitleStickyBevel

Determines the bevel to be drawn around the title bar if window is in unfocused state.

See Also: Bevel flags for further details.

TitleAlign

FIXME: add proper description here.

See Also: Alignment flags for further details.

TitleCompositionMethod

FIXME: add proper description here.

TitleFCompositionMethod

Alias for TitleFocusedCompositionMethod.

TitleUCompositionMethod

Alias for TitleUnfocusedCompositionMethod.

TitleSCompositionMethod

Alias for TitleStickyCompositionMethod.

TitleFocusedCompositionMethod

FIXME: add proper description here.

TitleUnfocusedCompositionMethod

FIXME: add proper description here.

TitleStickyCompositionMethod

FIXME: add proper description here.

TitleFHue

Alias for TitleFocusedHue.

TitleUHue

Alias for TitleUnfocusedHue.

TitleSHue

Alias for TitleStickyHue.

TitleFocusedHue

FIXME: add proper description here.

TitleUnfocusedHue

FIXME: add proper description here.

TitleStickyHue

FIXME: add proper description here.

TitleFSaturation

Alias for TitleFocusedSaturation.

TitleUSaturation

Alias for TitleUnfocusedSaturation.

TitleSSaturation

Alias for TitleStickySaturation.

TitleFocusedSaturation

FIXME: add proper description here.

TitleUnfocusedSaturation

FIXME: add proper description here.

TitleStickySaturation

FIXME: add proper description here.

TitleHSpacing value

Defines the space in pixel to insert between window title and the buttons/spacers. Please note that CondenseTitlebar is influencing the behaviour of this option.

TitleVSpacing value
InheritDefaults

FIXME: add proper description here.

Inherit frame_name

Specifies a MyFrame to inherit options from. Options from frame_name will override previously specified options for this frame. Inherit is a good way to save memory and network bandwidth if the same BackPixmap is used for several frames, as the pixmap will only be loaded for the inherited frame.

LeftBtnBackground

Defines the background to be used for the left buttons.

LeftSpacerBackground

Defines the background to be used for the (by default) leftmost spacer of the titlebar.

See Also: Titlebar Layout for further details.

LeftTitleSpacerBackground

Defines the background of the (by default) inner spacer, left of the window title.

TitleBackground

Defines the background to be used for the window title.

RightTitleSpacerBackground

Defines the background of the (by default) inner spacer, right of the window title.

RightSpacerBackground

Defines the background to be used for the (by default) rightmost spacer of the titlebar.

See Also: Titlebar Layout for further details.

RightBtnBackground

Defines the background to be used for the right buttons.

LeftBtnBackAlign

Defines the alignment of the background of the left buttons.

See Also: Alignment flags for further details.

LeftSpacerBackAlign

Defines the alignment of the background of the (by default) leftmost spacer of the titlebar.

See Also: Alignment flags for further details.

LeftTitleSpacerBackAlign

Defines the alignment of the background of the (by default) inner spacer, left of the window title.

See Also: Alignment flags for further details.

TitleBackgroundAlign

Defines the alignment of the background of the window title.

See Also: Alignment flags for further details.

RightTitleSpacerBackAlign

Defines the alignment of the background of the (by default) inner spacer, right of the window title.

See Also: Alignment flags for further details.

RightSpacerBackAlign

Defines the alignment of the background of the (by default) rightmost spacer of the titlebar.

See Also: Alignment flags for further details.

RightBtnBackAlign

Defines the alignment of the background of the right buttons.

See Also: Alignment flags for further details.

CondenseTitlebar Left|Right|Center

Allows titlebars to be smaller then the size of the window. The paramater defines the Alignment of the whole titlebar.

See Also: Alignment flags for further details.

LeftTitlebarLayout [Buttons] | [Spacer] | [TitleSpacer]

Defines the order of the elements in the titlebar left of the window title, where default is Spacer - Buttons - TitleSpacer.

See Also: Titlebar Layout Flags for further details.

RightTitlebarLayout [Buttons] | [Spacer] | [TitleSpacer]

Defines the order of the elements in the titlebar left of the window title, where default is TitleSpacer, Buttons, Spacer.

See Also: Titlebar Layout Flags for further details.

NoBorder

Denotes that beveled borders should not be drawn around the window frame and titlebar.

AllowBorder

Denotes that beveled borders should be drawn around the window frame and titlebar. This is on by default, so this option is only usefull in combination with inheriting previously defined window frames.

See Also: Inherit MyFrame for details.

LeftBtnAlign

Defines the alignment of the left buttons in the titlebar.

See Also: Look Alignment flags for further details.

RightBtnAlign

Defines the alignment of the right buttons in the titlebar.

See Also: Look Alignment flags for further details.

Window frame decorations (aka MyFrame)

Each window is surrounded by so-called frame decoration. each frame decoration could be built from 9 TBars:

1) Main Titlebar with icons on left, label in the middle and icons on right. Label may also have special underlying image - so called Title Background. Ordering of this elements is set by TitleButtonOrder setting ( see below ).

2) 4 frame sides. Each of this have fixed width that is determined by SideSize setting or image size if SideSize is ommited. Second dimension of the TBar changes to match the size of the window.

3) 4 frame corners. Each of this have both fixed width and height, as determined by CornerSize setting or image size.

Each of above elements is rendered by generating background using respective MyStyle, and then overlaying images/buttons and text on top of it. Default overlaying is done using composition method alpha-blend. In case of main Titlebar that could be changed. Bevel is then drawn on top of the image as specified in respective setting.

MyFrame allows different MyStyles to be used for titlebar and frame decorations. If any of those are ommited - default setting from FWindowStyle/UWindowStyle/SWindowStyle will be used.

Important: If you use semi-transparent images for frame sides - they will be overlayed on top of MyStyle generated background, so if you want it to be overlayed over root background - you should use MyStyle with BackPixmap set to 129 or 149.

Also note that unless you use MYStyle with BackPixmap 126 and 125 - frame decorations will not be shaped. Likewise if you want frame part to have only the shape of the image, you specified, with no background at all - use MyStyle with BackPixmap set like so :

BackPixmap 126 empty.xpm

Where empty.xpm is 1x1 completely transparent image (supplied as desktop/icons/common/empty.xpm ).

To identify side/corner it is possible to use abbreviations, such as: N, NW, SW, etc.

All the CompositionMethod settings must have one of the BackPixmap types from MyStyles ( ie 130-143 )

Align setting may have different meaning/capabilities for different items. When applied to text - it simply aligns text to sides mentioned. When applied to image - such as title background or frame side pixmap - it also specifies if image should be tiled, scaled or left same size. Make sure that you use HTiled,VTiled or HScaled,VScaled for frame sides - otherwise images on they will not be resized to match window size (this is also a feature :).

To center item specify Align to include both sides. For example :

Align Left,Right

will center item horizontally.

Note that TitleBackground option allows you to specify an image to be used under titlebar label in addition to the MyStyle. This was done for better shaped titlebars. You may have MyStyle to be completely transparent shape, while TitleBackground some non-transparent image, and that will provide better visibility for the titlebar text.

 MyFrame "name"
         Inherit     "name"]
     #traditional form :
         [North       ]
         [East        ]
         [South       ]
         [West        ]
         [NorthEast   ]
         [NorthWest   ]
         [SouthEast   ]
         [SouthWest   ]
     #alternative form :
         [Side        North|South|East|West|Any []] 
         if pixmap is ommited - empty bevel will be drawn
         [NoSide      North|South|East|West|Any]
         [Corner      NorthEast|SouthEast|NorthWest|SouthWest|Any ] 
         if pixmap is ommited - empty bevel will be drawn
         [NoCorner    NorthEast|SouthEast|NorthWest|SouthWest|Any]
     #new settings :
         [TitleUnfocusedStyle   ]
         [TitleFocusedStyle     ]
         [TitleStickyStyle      ]
         [FrameUnfocusedStyle   ]
         [FrameFocusedStyle     ]
         [FrameStickyStyle      ]
         [TitleBackground       ] 
             gets overlayed over background and under the text
         [LeftBtnBackground     ]
             gets overlayed over background and under the left block of buttons
         [LeftSpacerBackground  ]
             gets overlayed over background between left block of buttons and text label
         [RightSpacerBackground ] 
             gets overlayed over background between right block of buttons and text label
         [RightBtnBackground    ] 
             gets overlayed over background and under the right block of buttons
 
     #additional attributes :
         [SideSize        North|South|East|West|Any