Difference between revisions of "BGRAControls"

From Free Pascal wiki
Jump to navigationJump to search
m (→‎TBGRALabelFX: removed finished ToDo and a function that really doesn't works.)
 
(76 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
{{BGRAControls}}
 
{{BGRAControls}}
−
== Overview ==
 
  
−
'''Authors:'''
+
[[File:bgracontrols.png]]
  
−
Dibo (package founder and maintainer, author: ''TBGRAImageList'', ''TBGRASpeedButton'', ''TBGRAButton'', ''TBGRAPanel'')
+
== Install ==
  
−
Lainz (package maintainer, author: ''TBGRAImageButton'', ''TBGRAImageToggleBox'', ''TBGRASpriteAnimation'', ''TBGRALabelFX'')
+
Use the [[Online Package Manager]] to get BGRABitmap and BGRAControls.
  
−
Circular (package maintainer, author: ''TBGRAKnob'', ''TBGRAFlashProgressBar'', ''TBGRAVirtualScreen'', ''TBGRAShape'', ''TBGRAGraphicControl'')
+
Notice that you must check only the packages "bgrabitmappack.lpk" and "bgracontrols.lpk" in the Online Package Manager. The other packages are optional and may need third party packages / libraries to work (OpenGL and PascalScript).
  
−
Emerson Cavalcanti (author: ''TBGRAImageManipulation'')
+
=== Optional Components ===
  
−
codedeep (author: ''TBGRALabel'')
+
Since v4.4 the components TBCDefaultThemeManager, TBCKeyboard and TBCNumericKeyboard are not installed by default to allow Linux users to get a seamless installation with the Online Package Manager not installing third party stuff. If you want these components turn on the "Register unit" in the package options for each file (bcdefaulthememanager.pas, bckeyboard.pas, bcnumerickeyboard.pas) then compile and rebuild Lazarus. On Linux you need to install libxtst-dev and libgl-dev first.
  
−
'''License:''' Modified LGPL.
+
=== Website ===
  
−
As many people know, Lazarus GTK doesn't have full alpha support. I created a set of components which use TBGRABitmap for drawing icons, so it partially solves the problem with alpha in GTK. But this components set is not only a GTK patch but has more fancy components which are using the power of the BGRABitmap package.
+
BGRABitmap Organization on GitHub: https://github.com/bgrabitmap/
  
−
== Related Articles ==
+
== BGRA Controls ==
 +
 
 +
BGRA Controls is a set of graphical UI elements that you can use with Lazarus LCL applications.
 +
Under Linux you need to have installed libxtst-dev and libgl-dev.
 +
 
 +
=== TBCButton ===
 +
 
 +
[[Image:bcbutton.png]]
 +
 
 +
A button control that can be styled through properties for each state like StateClicked, StateHover, StateNormal with settings like gradients, border and text with shadows. You can assign an already made style through the property AssignStyle.
 +
 
 +
=== TBCButtonFocus ===
 +
 
 +
Like TBCButton but it supports focus like normal TButton.
 +
 
 +
=== TBCGameGrid ===
 +
 
 +
[[Image:bcgamegrid.png]]
 +
 
 +
A grid with custom width and height of items and any number of horizontal and vertical cells that can be drawn with BGRABitmap directly with the OnRenderControl event.
 +
 
 +
=== TBCImageButton ===
 +
 
 +
[[Image:samplebgraimagebutton.png]]
 +
 
 +
[[Image:samplebgraimagebuttonalpha.png]]
 +
 
 +
A button control that can be styled with one image file, containing the drawing for each state Normal, Hovered, Active and Disabled. It supports 9-slice scaling feature. It supports a nice fading animation that can be turned on.
 +
 
 +
=== TBCXButton ===
 +
 
 +
[[Image:bcxbutton.png]]
 +
 
 +
A button control that can be styled by code with the OnRenderControl event. Or even better create your own child control inheriting from this class.
 +
 
 +
=== TBCLabel ===
 +
 
 +
[[Image:bclabel.png]]
 +
 
 +
A label control that can be styled through properties, it supports shadow, custom borders and background.
 +
 
 +
=== TBCMaterialDesignButton ===
 +
 
 +
A button control that has an animation effect according to Google Material Design guidelines. It supports custom color for background and for the circle animation, also you can customize the shadow.
 +
 
 +
=== TBCPanel ===
 +
 
 +
[[Image:bcpanel.png]]
  
−
[[BGRAButton Gallery]] - Gallery of buttons with source code to use in your projects with BGRAButton.
+
A panel control that can be styled through properties. You can assign an already made style through the property AssignStyle.
  
−
[[BGRASpriteAnimation]] - Usage of the sprite animation component.
+
=== TBCRadialProgressBar ===
  
−
== Installation ==
+
A progress bar with radial style. You can set the color and text properties as you like.
  
−
'''BGRABitmap:''' http://wiki.lazarus.freepascal.org/BGRABitmap
+
=== TBCToolBar ===
  
−
'''BGRAControls:''' http://sourceforge.net/projects/bgracontrols/files/
+
A TToolBar with an event OnRedraw to paint it using BGRABitmap. It supports also the default OnPaintButton to customize the buttons drawing. By default it comes with a Windows 7 like explorer toolbar style.
  
−
'''Git repository:''' git://bgracontrols.git.sourceforge.net/gitroot/bgracontrols/bgracontrols
+
=== TBCTrackBarUpdown ===
  
−
Hint: If you are using [http://tortoisesvn.net/ TortoiseSVN] client for [[SVN]] you can use [http://code.google.com/p/tortoisegit/ TortoiseGIT] for [[GIT]].
+
A control to input numeric values with works like a trackbar and a spinedit both in one control.
  
−
Linux (GTK): You need lazarus 0.9.31 from SVN (revision >= 29834).
+
=== TBGRAFlashProgressBar ===
−
Windows (and others): You can use official lazarus 0.9.30.
 
  
−
You need to install the BGRABitmap package first (it is a requiered package in my package).
+
[[Image:BC-Bgraflashprogressbar.png]]
  
−
Install like other components by selecting bgracontrols.lpk from "Package->Open package file". This set of components is crossplatform (tested on linux GTK and windows)
+
A progress bar with a default style inspired in the old Flash Player Setup for Windows progress dialog. You can change the color property to have different styles and also you can use the event OnRedraw to paint custom styles on it like text or override the entire default drawing.
  
−
== Using ==
+
=== TBGRAGraphicControl ===
  
−
Drop TBGRAImageList or TBGRASpeedButton from "BGRA controls" palette and use like normal component. Example: Add icons, drop TToolBar and assign BGRAImageList to toolbar. Images property in object inspector.
+
Is like a paintbox. You can draw with transparency with this control using the OnRedraw event.
  
−
== TBGRAImageList ==
+
=== TBGRAImageList ===
  
−
'''Before:'''
+
An image list that supports alpha in all supported platforms.
 +
 
 +
How app looks with TImageList (with transparent icons):
  
 
[[Image:before-TImageList.png]]
 
[[Image:before-TImageList.png]]
  
−
'''After:'''
+
How app looks with BGRAImageList:
  
 
[[Image:after-TBGRAImageList.png]]
 
[[Image:after-TBGRAImageList.png]]
  
−
Component which inherits from TImageList. So each control (tested on TToolBar and TTreeView) which is using TImageList.Draw method for drawing icons, automatically can have alpha support. Just use this component instead of TImageList. This component has been written for enabling GTK alpha, so on Windows (and other interfaces) it works just like normal TImageList (it doesn't use BGRABitmap for drawing)
+
=== TBGRASVGImageList ===
  
−
== TBGRASpeedButton ==
+
It is located in the BGRA Themes tab.
 +
 
 +
[[Image:bgrasvgimagelist_edit.png|450px]]
 +
 
 +
In its properties, one can define the size and a target raster image list (TImageList or TBGRAImageList):
 +
 
 +
[[Image:bgrasvgimagelist_prop.png|350px]]
 +
 
 +
This will automatically populate the target image list (here on MacOS, it provides the double sized icons for Retina):
 +
 
 +
[[Image:targetimagelist_edit.png|350px]]
 +
 
 +
=== TBGRAImageManipulation ===
 +
 
 +
[[Image:bgraimagemanipulation.jpg]]
 +
 
 +
A tool to manipulate pictures, see the demo that shows all the capability that comes with it.
 +
 
 +
=== TBGRAKnob ===
 +
 
 +
[[Image:BC-Bgraknob.png]]
 +
 
 +
A knob that can be styled through properties.
 +
 
 +
=== TBGRAResizeSpeedButton ===
 +
 
 +
A speed button that can resize the glyph to fit in the entire control.
 +
 
 +
=== TBGRAShape ===
 +
 
 +
[[Image:samplebgrashape.png]]
 +
 
 +
A control with configurable shapes like polygon and ellipse that can be filled with gradients and can have custom borders and many other visual settings.
 +
 
 +
=== TBGRASpeedButton ===
  
 
[[Image:BGRASpeedButton.png]]
 
[[Image:BGRASpeedButton.png]]
  
−
Component which inherits from TSpeedButton and draws the glyph using TBGRABitmap. This component has been written for enabling GTK alpha, so on Windows (and other interfaces) it works just like normal TImageList (it doesn't use BGRABitmap for drawing)
+
A speed button that in GTK and GTK2 provides BGRABitmap powered transparency to the glyph.
 +
 
 +
=== TBGRASpriteAnimation ===
 +
 
 +
[[Image:bgraspriteanimation.png]]
 +
 
 +
A component that can be used as image viewer or animation viewer, supports the loading of gif files.
 +
 
 +
=== TBGRAVirtualScreen ===
  
−
== TBGRAButton ==
+
Is like a panel. You can draw this control using the OnRedraw event.
  
−
[[Image:bgrabutton.png]]
+
=== TDTAnalogClock ===
  
−
Customizable graphic component which is using only BGRABitmap functions for drawing. This component is insensitive for -dGTK_ONLY switch. Demo project included in package.
+
A clock.
  
−
Functionality:
+
=== TDTAnalogGauge ===
−
*Gradients
 
−
*Double gradients
 
−
*Rounding
 
−
*Border style, width and color
 
−
*Drop down list
 
−
*Glyph
 
−
*States (normal, hover, clicked)
 
−
*Caption with shadow
 
−
*Full alpha and antialias support
 
−
*Can work as image if no caption is set (has no stretch function yet)
 
  
−
== TBGRAPanel ==
+
A gauge.
  
−
Simple TPanel descendant which can have gradient background. Created especially for TBGRAButton (for creating a nice looking toolbar for bgrabuttons). This component is insensitive for -dGTK_ONLY switch
+
=== TDTThemedClock ===
  
−
== TBGRAKnob ==
+
Another clock.
−
[[Image:BC-Bgraknob.png]]
 
  
−
Graphic knob component created by circular.
+
=== TDTThemedGauge ===
  
−
== TBGRAFlashProgressBar ==
+
Another gauge.
  
−
[[Image:BC-Bgraflashprogressbar.png]]
+
=== TPSImport_BGRAPascalScript ===
  
−
Flash progressbar created by circular.
+
A component to load BGRABitmap pascal script utilities.
  
−
== TBGRAImageManipulation ==
+
== BGRA Custom Drawn ==
  
−
Component to facilitate the importation of images in an application.
+
BGRA Custom Drawn is a set of controls inherited from Custom Drawn. These come with a default dark style that is like Photoshop.
  
−
In the current version you can import an image and cut out keeping the aspect ratio (or not). For example, if you want to import photos using the 3x4 ratio, adjust the 'ratio' property to 3:4. If import an image with different size, the component will ensure that the image meets the proportions of the desired dimensions.
+
=== TBCDButton ===
  
−
You can determine the minimum size of the image adjusting the properties 'MinWidth'and 'MinHeight'.
+
A button control that is styled with TBGRADrawer.
  
−
You can rotate the image using functions builtin.
+
=== TBCDEdit ===
  
−
See demo of component:
+
An edit control that is styled with TBGRADrawer.
  
−
[[Image:bgraimagemanipulation.jpg]]
+
=== TBCDStaticText ===
  
−
After retrieving the image modified by the component, just put the image into your destination using the stretch. It is obvious that the target must have the same ratio chosen on component for do not distort the final result.
+
A label control that is styled with TBGRADrawer.
  
−
== TBGRAImageButton ==
+
=== TBCDProgressBar ===
  
−
[[Image:bgraimagebutton.png]]
+
A progress bar control that is styled with TBGRADrawer.
  
−
Component used to create a button with 4 states from Bitmap.
+
=== TBCDSpinEdit ===
  
−
The bitmap must contain the 4 states (from top to bottom, with the same Height) in the following order: normal, enter, pressed, disabled.
+
A spin edit control that is styled with TBGRADrawer.
  
−
''Example Button:''
+
=== TBCDCheckBox ===
  
−
[[Image:samplebgraimagebutton.png]]
+
A check box control that is styled with TBGRADrawer.
  
−
''Example Button (with Alpha):''
+
=== TBCRadioButton ===
  
−
[[Image:samplebgraimagebuttonalpha.png]]
+
A radio button that is styled with TBGRADrawer.
  
−
== TBGRAVirtualScreen ==
+
== Sample code ==
  
−
The principle is to draw on a memory bitmap.
+
BGRA Controls comes with nice demos to show how to use the stuff and extra things you can use in your own projects.
  
−
The component has a specific event, OnRedraw, which is called when the whole bitmap needs to be redrawn. It happens at the beginning, when resizing and when the Redraw method is called.
+
=== Pascal Script Library ===
  
−
Otherwise, it is possible to modify the Bitmap property and call Invalidate or Repaint, to avoid erasing the whole bitmap content.
+
Putting BGRABitmap methods into a .dll with c#, java and pascal headers.
  
−
== TBGRAShape ==
+
=== BGRA Ribbon Custom ===
  
−
Use as replace of TShape.
+
How to create a fully themed window using the controls to achieve a Ribbon like application.
  
−
[[Image:samplebgrashape.png]]
+
=== Tests ===
  
−
The component has full alpha support and you can put the number of polygons you want with rounded borders & gradients (linear, radial, diamond, reflected).
+
There are test for analog controls (clock and gauge), BC prefixed controls, BGRA prefixed controls, BGRA Custom Drawn controls, how to use Pascal Script and BGRABitmap, bgrascript or how to create your own scripting solution with BGRABitmap.
  
−
== TBGRAImageToggleBox ==
+
=== Tests Extra ===
  
−
Component used to create a toggle box from Bitmap.
+
[[Image:game_maze.png]]
  
−
The bitmap must contain 8 images (from top to bottom, with the same Height) in the following order: unchecked normal, unchecked enter, unchecked pressed, unchecked disabled for Unchecked state and checked normal, checked enter, checked pressed, checked disabled for Normal state.
+
[[Image:game_puzzle.png]]
  
−
''Example toggle box:''
+
[[Image:customdrawnwindows7.png]]
  
−
[[Image:sampletogglebox.png]]
+
[[File:slicescaledtachart.png]]
  
−
== TBGRAGraphicControl ==
+
These are extra tests like how to use fading effect, an fpGUI theme, games like maze and puzzle, how we created the material design animation, pix2svg or how to convert a small picture to svg using hexagons, rectangles and ellipses, plugins or how to load .dlls and use into a TBGRAVirtualScreen, rain effect, shadow effect, 9-slice-scaling with Custom Drawn or how to theme with bitmaps an application to look like Windows themes and 9-slice-scaling with charts.
  
−
TBGRAGraphicControl, which allows to draw your component by yourself with alpha blending.
+
== Other units ==
  
−
== TBGRASpriteAnimation ==
+
These units come with BGRA Controls and contains more functionality that is sometimes used with the controls, sometimes not but are usefull in some way. Some are listed here, others you can see linked directly with any control like bcrtti, bcstylesform, bctools and bctypes.
  
−
Read more in the article [[BGRASpriteAnimation]].
+
=== BCEffect ===
  
−
With this you can do animations from bitmap. You need an image with all the frames layout in in a horizontal position.
+
Fading effect with BGRABitmap.
  
−
It has the ability to specify how many times the animation should be played (0 for infinite, 1, 2, etc) and static to stop the animation, is capable to specify the speed and direction and support transparency.
+
=== BCFilters ===
  
−
Features:
+
A set of pixel filters to use with BGRABitmap.
−
* Animation: invert, position, lap, speed, static, repeat.
 
−
* Sprite: fill opacity (global transparency), flip mode (horizontal, vertical, both), key color (transparent color), resample (normal or fine resample modes). AutoSize.
 
  
−
== TBGRALabel ==
+
=== BGRAScript ===
  
−
Label component based on TBGRAButton.
+
Scripting with BGRABitmap, see test project.
  
−
Features:
+
== Related Articles ==
−
* Caption with shadow or not
 
−
* Full alpha and antialias support or not
 
−
* WordWarp or not
 
−
* Caption with Property Editor Multiline
 
  
−
== TBGRALabelFX ==
+
[[BGRASpriteAnimation]] - Usage of the sprite animation component.
  
−
[[Image:bgralabelfx.png]]
+
[[uE_Controls]] - Other controls developed with BGRABitmap.
  
−
Features:
+
[[BGRABitmap]] - The library used to create this controls.
−
* Outline
 
−
* Shadow
 
  
−
ToDo:
+
[[LazPaint]] - A paint program developed with Lazarus and BGRABitmap.
−
* Use BGRATextFX multicolor, textures.
 
−
* etc.
 
  
 
[[Category:Components]]
 
[[Category:Components]]
 +
[[Category:Graphics]]
 +
[[Category:BGRAControls]]

Latest revision as of 21:27, 13 August 2023

│ Deutsch (de) │ English (en) │ português (pt) │ русский (ru) │ 中文（中国大陆）‎ (zh_CN) │

bgracontrols.png

Install

Use the Online Package Manager to get BGRABitmap and BGRAControls.

Notice that you must check only the packages "bgrabitmappack.lpk" and "bgracontrols.lpk" in the Online Package Manager. The other packages are optional and may need third party packages / libraries to work (OpenGL and PascalScript).

Optional Components

Since v4.4 the components TBCDefaultThemeManager, TBCKeyboard and TBCNumericKeyboard are not installed by default to allow Linux users to get a seamless installation with the Online Package Manager not installing third party stuff. If you want these components turn on the "Register unit" in the package options for each file (bcdefaulthememanager.pas, bckeyboard.pas, bcnumerickeyboard.pas) then compile and rebuild Lazarus. On Linux you need to install libxtst-dev and libgl-dev first.

Website

BGRABitmap Organization on GitHub: https://github.com/bgrabitmap/

BGRA Controls

BGRA Controls is a set of graphical UI elements that you can use with Lazarus LCL applications. Under Linux you need to have installed libxtst-dev and libgl-dev.

TBCButton

bcbutton.png

A button control that can be styled through properties for each state like StateClicked, StateHover, StateNormal with settings like gradients, border and text with shadows. You can assign an already made style through the property AssignStyle.

TBCButtonFocus

Like TBCButton but it supports focus like normal TButton.

TBCGameGrid

bcgamegrid.png

A grid with custom width and height of items and any number of horizontal and vertical cells that can be drawn with BGRABitmap directly with the OnRenderControl event.

TBCImageButton

samplebgraimagebutton.png

samplebgraimagebuttonalpha.png

A button control that can be styled with one image file, containing the drawing for each state Normal, Hovered, Active and Disabled. It supports 9-slice scaling feature. It supports a nice fading animation that can be turned on.

TBCXButton

bcxbutton.png

A button control that can be styled by code with the OnRenderControl event. Or even better create your own child control inheriting from this class.

TBCLabel

bclabel.png

A label control that can be styled through properties, it supports shadow, custom borders and background.

TBCMaterialDesignButton

A button control that has an animation effect according to Google Material Design guidelines. It supports custom color for background and for the circle animation, also you can customize the shadow.

TBCPanel

bcpanel.png

A panel control that can be styled through properties. You can assign an already made style through the property AssignStyle.

TBCRadialProgressBar

A progress bar with radial style. You can set the color and text properties as you like.

TBCToolBar

A TToolBar with an event OnRedraw to paint it using BGRABitmap. It supports also the default OnPaintButton to customize the buttons drawing. By default it comes with a Windows 7 like explorer toolbar style.

TBCTrackBarUpdown

A control to input numeric values with works like a trackbar and a spinedit both in one control.

TBGRAFlashProgressBar

BC-Bgraflashprogressbar.png

A progress bar with a default style inspired in the old Flash Player Setup for Windows progress dialog. You can change the color property to have different styles and also you can use the event OnRedraw to paint custom styles on it like text or override the entire default drawing.

TBGRAGraphicControl

Is like a paintbox. You can draw with transparency with this control using the OnRedraw event.

TBGRAImageList

An image list that supports alpha in all supported platforms.

How app looks with TImageList (with transparent icons):

before-TImageList.png

How app looks with BGRAImageList:

after-TBGRAImageList.png

TBGRASVGImageList

It is located in the BGRA Themes tab.

bgrasvgimagelist edit.png

In its properties, one can define the size and a target raster image list (TImageList or TBGRAImageList):

bgrasvgimagelist prop.png

This will automatically populate the target image list (here on MacOS, it provides the double sized icons for Retina):

targetimagelist edit.png

TBGRAImageManipulation

bgraimagemanipulation.jpg

A tool to manipulate pictures, see the demo that shows all the capability that comes with it.

TBGRAKnob

BC-Bgraknob.png

A knob that can be styled through properties.

TBGRAResizeSpeedButton

A speed button that can resize the glyph to fit in the entire control.

TBGRAShape

samplebgrashape.png

A control with configurable shapes like polygon and ellipse that can be filled with gradients and can have custom borders and many other visual settings.

TBGRASpeedButton

BGRASpeedButton.png

A speed button that in GTK and GTK2 provides BGRABitmap powered transparency to the glyph.

TBGRASpriteAnimation

bgraspriteanimation.png

A component that can be used as image viewer or animation viewer, supports the loading of gif files.

TBGRAVirtualScreen

Is like a panel. You can draw this control using the OnRedraw event.

TDTAnalogClock

A clock.

TDTAnalogGauge

A gauge.

TDTThemedClock

Another clock.

TDTThemedGauge

Another gauge.

TPSImport_BGRAPascalScript

A component to load BGRABitmap pascal script utilities.

BGRA Custom Drawn

BGRA Custom Drawn is a set of controls inherited from Custom Drawn. These come with a default dark style that is like Photoshop.

TBCDButton

A button control that is styled with TBGRADrawer.

TBCDEdit

An edit control that is styled with TBGRADrawer.

TBCDStaticText

A label control that is styled with TBGRADrawer.

TBCDProgressBar

A progress bar control that is styled with TBGRADrawer.

TBCDSpinEdit

A spin edit control that is styled with TBGRADrawer.

TBCDCheckBox

A check box control that is styled with TBGRADrawer.

TBCRadioButton

A radio button that is styled with TBGRADrawer.

Sample code

BGRA Controls comes with nice demos to show how to use the stuff and extra things you can use in your own projects.

Pascal Script Library

Putting BGRABitmap methods into a .dll with c#, java and pascal headers.

BGRA Ribbon Custom

How to create a fully themed window using the controls to achieve a Ribbon like application.

Tests

There are test for analog controls (clock and gauge), BC prefixed controls, BGRA prefixed controls, BGRA Custom Drawn controls, how to use Pascal Script and BGRABitmap, bgrascript or how to create your own scripting solution with BGRABitmap.

Tests Extra

game maze.png

game puzzle.png

customdrawnwindows7.png

slicescaledtachart.png

These are extra tests like how to use fading effect, an fpGUI theme, games like maze and puzzle, how we created the material design animation, pix2svg or how to convert a small picture to svg using hexagons, rectangles and ellipses, plugins or how to load .dlls and use into a TBGRAVirtualScreen, rain effect, shadow effect, 9-slice-scaling with Custom Drawn or how to theme with bitmaps an application to look like Windows themes and 9-slice-scaling with charts.

Other units

These units come with BGRA Controls and contains more functionality that is sometimes used with the controls, sometimes not but are usefull in some way. Some are listed here, others you can see linked directly with any control like bcrtti, bcstylesform, bctools and bctypes.

BCEffect

Fading effect with BGRABitmap.

BCFilters

A set of pixel filters to use with BGRABitmap.

BGRAScript

Scripting with BGRABitmap, see test project.

Related Articles

BGRASpriteAnimation - Usage of the sprite animation component.

uE_Controls - Other controls developed with BGRABitmap.

BGRABitmap - The library used to create this controls.

LazPaint - A paint program developed with Lazarus and BGRABitmap.

Retrieved from "http://wiki.freepascal.org/index.php?title=BGRAControls&oldid=157089"