MyFrame(1)

NAME
MyFrame - defines how AfterStep should construct window's frame LookAlignment flagsBevel flagsMyBackgroundMyFrameMyStyleSuported hintsTitlebar layout

CONFIGURATION OPTIONS
AllowBorderDenotes 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. CondenseTitlebarLeft|Right|CenterAllows titlebars to be smaller then the size of the window. The paramater defines the Alignment of the whole titlebar.See Also:Alignment flagsfor further details. Corner[ SouthEast | SouthWest | NorthEast | NorthWest ]"pixmap_name"Specifies the corner of the window frame to be decorated and the pixmap to be used. CornerAlignFIXME: add proper description here.See Also:Alignment flagsfor further details. CornerBevelBottom|Extra|NoInline|NoOutline|none|Left|Right|TopSets the default bevel of a window s frame corners.If you need different bevels for the different window states, use CornerFocusedBevel, CornerUnfocusedBevel, CornerStickyBevelSee Also:Bevel flagsfor further details. CornerFBevelAlias for CornerFocusedBevel.See Also:Bevel flagsfor further details. CornerFocusedBevelBottom|Extra|NoInline|NoOutline|none|Left|Right|TopSets the bevel of the window s frame corners while window is in focused state.If this is not used, values set with CornerBevel will be used.See Also:Bevel flagsfor further details. CornerSBevelAlias for CornerStickyBevel.See Also:Bevel flagsfor further details. CornerSizeNorthEast|SouthEast|NorthWest|SouthWest|Any WIDTHxHEIGHTFIXME: add proper description here. CornerStickyBevelNorthEast|SouthEast|NorthWest|SouthWest|Any None|[Left,Top,Right,Bottom,Extra,NoOutline]Sets the bevel of the window s frame corners while window is in sticky state. This overwrites any value set with CornerBevel.If this is not used, values set with CornerBevel will be used.See Also:Bevel flagsfor further details. CornerUBevelAlias for CornerUnfocusedBevel.See Also:Bevel flagsfor further details. CornerUnfocusedBevelBottom|Extra|NoInline|NoOutline|none|Left|Right|TopSets the bevel of the window s frame corners while window is in unfocused state.If this is not used, values set with CornerBevel will be used.See Also:Bevel flagsfor further details. East"pixmap_name"Specifies the pixmap to be displayed in the right border of the window frame, if DecorateFrames is set. FrameFStyleMyStyleAlias for FrameFocusedStyle. FrameFocusedStyleMyStyleDefines the MyStyle to apply to the window frame if window is in focused state. FrameSStyleMyStyleAlias for FrameStickyStyle. FrameStickyStyleMyStyleDefines the MyStyle to apply to the window frame if window is in sticky state. FrameUStyleMyStyleAlias for FrameUnfocusedStyle. FrameUnfocusedStyleMyStyleDefines the MyStyle to apply to the window frame if window is in unfocused state. Inheritframe_nameSpecifies 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. InheritDefaultsFIXME: add proper description here. LeftBtnAlignDefines the alignment of the left buttons in the titlebar.See Also:Look Alignment flagsfor further details. LeftBtnBackAlignDefines the alignment of the background of the left buttons.See Also:Alignment flagsfor further details. LeftBtnBackgroundDefines the background to be used for the left buttons. LeftSpacerBackAlignDefines the alignment of the background of the (by default) leftmost spacer of the titlebar.See Also:Alignment flagsfor further details. LeftSpacerBackgroundDefines the background to be used for the (by default) leftmost spacer of the titlebar.See Also:Titlebar Layoutfor further details. LeftTitleSpacerBackAlignDefines the alignment of the background of the (by default) inner spacer, left of the window title.See Also:Alignment flagsfor further details. LeftTitleSpacerBackgroundDefines the background of the (by default) inner spacer, left of the window title. 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 Flagsfor further details. MyFrame "frame_name" frame_option~MyFrameSpecifies the beginning of a frame definition. The frame can be referred to later byframe_name.~MyFrameends a frame definition. NoBorderDenotes that beveled borders should not be drawn around the window frame and titlebar. NoCornerFIXME: add proper description here. NoSideFIXME: add proper description here. North"pixmap_name"Specifies the pixmap to be displayed in the top border 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. NorthWest"pixmap_name"Specifies the pixmap to be displayed in the top left corner of the window frame, if DecorateFrames is set. RightBtnAlignDefines the alignment of the right buttons in the titlebar.See Also:Look Alignment flagsfor further details. RightBtnBackAlignDefines the alignment of the background of the right buttons.See Also:Alignment flagsfor further details. RightBtnBackgroundDefines the background to be used for the right buttons. RightSpacerBackAlignDefines the alignment of the background of the (by default) rightmost spacer of the titlebar.See Also:Alignment flagsfor further details. RightSpacerBackgroundDefines the background to be used for the (by default) rightmost spacer of the titlebar.See Also:Titlebar Layoutfor further details. RightTitleSpacerBackAlignDefines the alignment of the background of the (by default) inner spacer, right of the window title.See Also:Alignment flagsfor further details. RightTitleSpacerBackgroundDefines the background of the (by default) inner spacer, right of the window title. 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 Flagsfor further details. Side[ South | North | East | West ]"pixmap_name"Specifies the side of the window frame to be decorated and the pixmap to be used. SideAlignFIXME: add proper description here.See Also:Alignment flagsfor further details. SideBevelBottom|Extra|NoInline|NoOutline|none|Left|Right|TopSets the default bevel of a window s frame sides.If you need different bevels for the different window states, use SideFocusedBevel, SideUnfocusedBevel, SideStickyBevelSee Also:Bevel flagsfor further details. SideFBevelAlias for SideFocusedBevel.See Also:Bevel flagsfor further details. SideFocusedBevelBottom|Extra|NoInline|NoOutline|none|Left|Right|TopSets the bevel of the window s frame sides while window is in focused state.If this is not used, values set with SideBevel will be used.See Also:Bevel flagsfor further details. SideSBevelAlias for SideStickyBevel.See Also:Bevel flagsfor further details. SideSizeFIXME: add proper description here. SideSlicingFIXME: add proper description here. SideStickyBevelBottom|Extra|NoInline|NoOutline|none|Left|Right|TopSets the bevel of the window s frame sides while window is in sticky state.If this is not used, values set with SideBevel will be used.See Also:Bevel flagsfor further details. SideUBevelAlias for SideUnfocusedBevel.See Also:Bevel flagsfor further details. SideUnfocusedBevelBottom|Extra|NoInline|NoOutline|none|Left|Right|TopSets the bevel of the window s frame sides while window is in unfocused state.If this is not used, values set with SideBevel will be used.See Also:Bevel flagsfor further details. South"pixmap_name"Specifies the pixmap to be displayed in the bottom border 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. SouthWest"pixmap_name"Specifies the pixmap to be displayed in the bottom left corner of the window frame, if DecorateFrames is set. TitleAlignFIXME: add proper description here.See Also:Alignment flagsfor further details. TitleBackgroundDefines the background to be used for the window title. TitleBackgroundAlignDefines the alignment of the background of the window title.See Also:Alignment flagsfor further details. TitleBevelDetermines the bevel to be drawn around the title bar. If you wish to have different bevels, depending on the window s state, use TitleFocusedBevel, TitleUnfocusedBevel or TitleStickyBevel.See Also:Bevel flagsfor further details. TitleCompositionMethodFIXME: add proper description here. TitleFBevelAlias for TitleFocusedBevel.See Also:Bevel flagsfor further details. TitleFCompositionMethodAlias for TitleFocusedCompositionMethod. TitleFHueAlias for TitleFocusedHue. TitleFSaturationAlias for TitleFocusedSaturation. TitleFStyleMyStyleAlias for TitleFocusedStyle. TitleFocusedBevelDetermines the bevel to be drawn around the title bar if window is in focused state.See Also:Bevel flagsfor further details. TitleFocusedCompositionMethodFIXME: add proper description here. TitleFocusedHueFIXME: add proper description here. TitleFocusedSaturationFIXME: add proper description here. TitleFocusedStyleMyStyleMyStyle to apply to titlebar if window is in focused state. TitleHSpacingvalueDefines the space in pixel to insert between window title and the buttons/spacers. Please note that CondenseTitlebar is influencing the behaviour of this option. TitleSBevelAlias for TitleStickyBevel.See Also:Bevel flagsfor further details. TitleSCompositionMethodAlias for TitleStickyCompositionMethod. TitleSHueAlias for TitleStickyHue. TitleSSaturationAlias for TitleStickySaturation. TitleSStyleMyStyleAlias for TitleStickyStyle. TitleStickyBevelDetermines the bevel to be drawn around the title bar if window is in unfocused state.See Also:Bevel flagsfor further details. TitleStickyCompositionMethodFIXME: add proper description here. TitleStickyHueFIXME: add proper description here. TitleStickySaturationFIXME: add proper description here. TitleStickyStyleMyStyleMyStyle to apply to titlebar if window is in sticky state. TitleUBevelAlias for TitleUnfocusedBevel.See Also:Bevel flagsfor further details. TitleUCompositionMethodAlias for TitleUnfocusedCompositionMethod. TitleUHueAlias for TitleUnfocusedHue. TitleUSaturationAlias for TitleUnfocusedSaturation. TitleUStyleMyStyleAlias for TitleUnfocusedStyle. TitleUnfocusedBevelDetermines the bevel to be drawn around the title bar if window is in unfocused state.See Also:Bevel flagsfor further details. TitleUnfocusedCompositionMethodFIXME: add proper description here. TitleUnfocusedHueFIXME: add proper description here. TitleUnfocusedSaturationFIXME: add proper description here. TitleUnfocusedStyleMyStyleMyStyle to apply to titlebar if window is in unfocused state. TitleVSpacingvalue West"pixmap_name"Specifies the pixmap to be displayed in the left border of the window frame, if DecorateFrames is set. 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.xpmWhere 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,Rightwill 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