Archive for the ‘Programming’ Category
Aero Glass in GlassCalc (part 1)
Posted in (Programming) by Joel on Jul 09, 2010I got a couple questions about how I made the Aero Glass effects in GlassCalc. When I started making GlassCalc, I had no idea how to manage Aero Glass, but Google came to my rescue. What I eventually came up with is the amalgamation of code snippets and general knowledge from countless separate articles and examples. I'll link to as many of those pages as I can remember, but I'll try and bring everything together in one place here.
Note: GlassCalc is written in C# using WPF for its UI. As such, some of the code examples below are C#, .NET, or WPF specific.
Every window in Windows has a client area and a non-client area. The client area is everything you get to handle and draw on. Normally, this is everything inside the window frame. The non-client area is everything Windows handles by itself: the window frame, icon, window title, min/max/close buttons, resize handles, etc...
Using the Windows API, programs can modify the glass frame and the client/non-client areas. Generally, they either extend the glass frame into the client area, or they extend the client area into the glass frame. GlassCalc does both.
With the default interface, GlassCalc extends the top and bottom of the frame. The client area is still the same size, but the glass frame has been extended into the client area, so GlassCalc can draw the menu and the input box over glass.
With the full glass interface, GlassCalc extends the frame to cover the entire window, so everything is drawn over glass, but it also draws the menu bar inside the title. This is done by extending the client area upwards so GlassCalc can draw there. This effect takes quite a lot more work, because now that GlassCalc has taken over the non-client area, it must handle all the things Windows used to handle in this area.
Extending the glass frame
All of the code here involves Windows API calls in some way. To organize everything, I'm putting all Windows API functions and structures in a class called Interop. (some examples use the name NativeMethods) I'll also make a class called GlassHelper which will (quite appropriately) help deal with Aero Glass.
To extend the glass frame, we need to import a function called DwmExtendFrameIntoClientArea from dwmapi.dll. Since Aero can be disabled, we also need to know whether we can extend the frame or not. For this, we import DwmIsCompositionEnabled. DwmExtendFrameIntoClientArea takes a Margins structure as one of its arguments. Since there is no Margins structure in C#, we need to define it ourselves. Much of the following code comes from this informative article.
Note: You can copy the source of these code examples by hovering over the code, then clicking the view source icon in the toolbar that appears in the upper-right corner.
public static class Interop
{
[StructLayout(LayoutKind.Sequential)]
public struct Margins
{
public int Left;
public int Right;
public int Top;
public int Bottom;
public Margins(Thickness t)
{
Left = (int)t.Left;
Right = (int)t.Right;
Top = (int)t.Top;
Bottom = (int)t.Bottom;
}
}
[DllImport("dwmapi.dll", PreserveSig = false)]
public static extern void DwmExtendFrameIntoClientArea(IntPtr hwnd, ref Margins margins);
[DllImport("dwmapi.dll", PreserveSig = false)]
public static extern bool DwmIsCompositionEnabled();
}
Now, we'll make a class that can make use of these functions.
public static class GlassHelper
{
/// <summary>
/// Gets whether dwmapi.dll is present and DWM functions can be used
/// </summary>
public static bool IsDwmCompositionAvailable
{
get
{
// Vista is version 6. Don't do aero stuff if not >= Vista because dwmapi.dll won't exist
return Environment.OSVersion.Version.Major >= 6;
}
}
/// <summary>
/// Gets whether DWM is enabled
/// </summary>
public static bool IsDwmCompositionEnabled
{
get
{
// Make sure dwmapi.dll is present. If not, calling DwmIsCompositionEnabled will throw an exception
if (!IsDwmCompositionAvailable)
return false;
return Interop.DwmIsCompositionEnabled();
}
}
/// <summary>
/// Extends the glass frame of a window
/// </summary>
public static bool ExtendGlassFrame(Window window, Thickness margin)
{
if (!IsDwmCompositionEnabled)
return false;
IntPtr hwnd = new WindowInteropHelper(window).Handle;
if (hwnd == IntPtr.Zero)
throw new InvalidOperationException("The Window must be shown before extending glass.");
HwndSource source = HwndSource.FromHwnd(hwnd);
// Set the background to transparent from both the WPF and Win32 perspectives
window.Background = Brushes.Transparent;
source.CompositionTarget.BackgroundColor = Colors.Transparent;
Interop.Margins margins = new Interop.Margins(margin);
Interop.DwmExtendFrameIntoClientArea(hwnd, ref margins);
return true;
}
}
Finally, in override your application's OnSourceInitialized method to call ExtendGlassFrame. The Thickness object you pass in defines how far in the frame should be extended from each of the sides. If you use -1 for each dimension (like in the code below), the glass will cover the entire window.
public sealed partial class YourApp : Window
{
. . .
protected override void OnSourceInitialized(EventArgs e)
{
base.OnSourceInitialized(e);
GlassHelper.ExtendGlassFrame(this, new Thickness(-1));
}
. . .
}
Make the glass area act like an extension of the title bar
If you extend the frame from the top such that the title bar appears bigger, (like in the default GlassCalc interface) you probably also want to make it so that when a user clicks in this empty area, they can drag the window. You can do this by detecting a MouseLeftButtonDown event inside the extended title bar area and calling your window's DragMove function.
What if Aero gets disabled while my program is running?
There is one other thing you should take care of when extending the frame. If a user turns off Aero while your application is running, you'll get big black areas where there used to be glass because your window background is transparent. Windows sends a WM_DWMCOMPOSITIONCHANGED message to your application when Aero is turned on or off, so you can handle this by setting up a function to listen for this message.
Add this constant to Interop.
public static class Interop
{
public const int WM_DWMCOMPOSITIONCHANGED = 0x031E;
. . .
}
Now, set up a function to listen for messages. When it gets a WM_DWMCOMPOSITIONCHANGED message, check to see whether Aero was enabled or disabled. If Aero was enabled, extend the frame again. If it was disabled, set the background color back to its original value. (This example assumes your window background was white. You could improve it by saving the background color before extending the frame, then reverting it when Aero is disabled.)
public sealed partial class YourApp : Window
{
. . .
/// <summary>
/// Processes messages sent to this window
/// </summary>
private IntPtr WndProc(IntPtr hwnd, int msg, IntPtr wParam, IntPtr lParam, ref bool handled)
{
if (msg == Interop.WM_DWMCOMPOSITIONCHANGED)
{
if (GlassHelper.IsDwmCompositionEnabled)
{
// Aero was re-enabled. Extend the glass again.
GlassHelper.ExtendGlassFrame(this, new Thickness(-1));
}
else
{
// Aero was disabled. Reset the window's background color to remove black areas
HwndSource source = PresentationSource.FromVisual(this) as HwndSource;
source.CompositionTarget.BackgroundColor = Colors.White;
this.Background = Brushes.White;
}
}
}
protected override void OnSourceInitialized(EventArgs e)
{
base.OnSourceInitialized(e);
// Hook up the WndProc function so it receives messages
HwndSource source = PresentationSource.FromVisual(this) as HwndSource;
source.AddHook(WndProc);
GlassHelper.ExtendGlassFrame(this, new Thickness(-1));
}
. . .
}
Extending the client area
Since this is already a very long post, and the part on extending the client area will probably be even longer, I'm going to split it up. Extending the client area into the frame will come in part 2... whenever I get around to writing that. For now, here are some of the links I found most useful while figuring this stuff out.
- A nice article on extending glass frames: http://blogs.msdn.com/b/adam_nathan/archive/2006/05/04/589686.aspx
- Great article on window chrome: http://blogs.msdn.com/b/wpfsdk/archive/2008/09/08/custom-window-chrome-in-wpf.aspx
- How I figure out DLL imports and Windows API constants: http://pinvoke.net
- Google is my friend.
Putting Netbeans AppData in the Right Place
Posted in (Programming) by Joel on Jun 24, 2010If you use Windows Vista/7 and Netbeans, you've likely seen a .netbeans and .netbeans-registration folder appear in your user directory. Netbeans is a very nice piece of software, but like many open-source programs, it goes by the mistaken belief that application data always goes in the home folder. This is perfectly normal for Linux, but Windows is not Linux. Windows application settings go in the AppData folder. It is possible to get Netbeans to store its settings in the right place, and it isn't too difficult.
This guide will show you how to put Netbeans settings in the right place for Windows Vista/7, but you can also use it to put the settings directories anywhere you want on any system. I'll assume you are using Netbeans 6.9. If not, change the version number where appropriate.
Find netbeans.conf
Open an explorer window and find the directory where Netbeans is installed. The default location is C:\Program Files\Netbeans 6.9 (C:\Program Files (x86)\Netbeans 6.9 for 64 bit systems). Inside it, there should be a folder called etc and inside that, a file called netbeans.conf. Run an instance of your preferred text editor as administrator (you won't be able to save the file otherwise) and open netbeans.conf in it.
Change netbeans_default_userdir
The second line of netbeans.conf defines the settings directory. Change it to look like this:
# ${HOME} will be replaced by JVM user.home system property
netbeans_default_userdir="${HOME}/AppData/Roaming/Netbeans"
If you move your .netbeans and .netbeans-registration folders to this new location, Netbeans will pick up your settings, but it will still create the same two directories in your user directory and it will ask you to register again. This is because there are actually two options you need to change. The second one is a little harder to find.
Define -J-Duser.home
Line 6 of netbeans.conf defines a bunch of options, each starting with -J. You need to add another option to this line. Before the quote at the end of the line, add this: (replace USERNAME with your username)
-J-Duser.home=C:/Users/USERNAME/AppData/Roaming/Netbeans
Your netbeans.conf file should look something like this now.
# ${HOME} will be replaced by JVM user.home system property
netbeans_default_userdir="${HOME}/AppData/Roaming/Netbeans"
# Options used by NetBeans launcher by default, can be overridden by explicit
# command line switches:
netbeans_default_options="-J-client -J-Xss2m -J-Xms32m -J-XX:PermSize=32m -J-XX:MaxPermSize=200m -J-Dapple.laf.useScreenMenuBar=true -J-Dsun.java2d.noddraw=true -J-Duser.home=C:/Users/USERNAME/AppData/Roaming/Netbeans"
# Note that a default -Xmx is selected for you automatically.
. . .
And now you're done! Netbeans should no longer clutter your user directory with its settings.
Adsense, Without Blocking
Posted in (Programming, Web) by Joel on Jun 04, 2010My web pages pause at ads for a moment. Why?
In some (but not necessarily all) web browsers, if you place a script in the middle of a web page, it has to be executed before the browser can continue rendering the page. The AdSense script is quite slim, but your browser still has to request the JavaScript file from Google, which could take a while depending your Internet speed. This means your pages might load up to the ad, pause a little while, then continue loading. Fortunately, there is a very simple way to keep scripts from blocking your content: put them at the end of the page. This way, all your content is loaded before the scripts are downloaded and executed. Unfortunately, this also puts all your ads at the bottom of the page, but with a little JavaScript, you can put your ads back where they belong.
How to fix it
First, you'll need some sort of placeholder for where an ad should go. Use a div and set its id so you can easily find it with JavaScript. If you have multiple ads, number the ids so you can replace them all with a loop.
<div id="ad-0"> <!-- the first ad goes here --> </div> <div id="ad-1"> <!-- a second ad goes here --> </div>
Now, place the AdSense JavaScript at the end of the page. Put each ad inside a div with an id so you can easily find it with JavaScript. Put the everything in a div with display set to none so your ads won't briefly appear at the bottom of the page.
<div style="display:none">
<div id="adsource-0">
<script type="text/javascript"><!--
google_ad_client = "pub-xxxxxxxxxxxxxxxx";
/* Ad Name */
google_ad_slot = "##########";
google_ad_width = 125;
google_ad_height = 125;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
<div id="adsource-1">
...
</div>
</div>
Finally, use JavaScript to move each ad to its proper place. This script uses document.getElementById to find the ad and the placeholder, then it uses appendChild to move the ad into the placeholder div.
<script type="text/javascript">
numAds = 1;
for (var i = 0; i < numAds; i++) {
source = document.getElementById("adsource-" + i);
placeholder = document.getElementById("ad-" + i);
placeholder.appendChild(source);
}
</script>
How well does it work?
Consider this entire site a live tech demo. Refresh the page and watch under the "Advertisements" header of the sidebar. After all of the content is loaded, the ads pop into place.
It breaks my layout!
With this setup, the placeholders initially take up no space, so they expand when the ad gets loaded. If this breaks your layout, you can set the height and width of the placeholder to the dimensions of the ad like this:
<div id="ad-0" style="width: 125px; height: 125px"> <!-- this placeholder takes up space! --> </div>
Edit (A bit later, still June 4)
Apparently, this is what I get for writing a post about AdSense. See? This is why we can't have nice things.
GlassCalc Feedback
Posted in (Programming) by Joel on Jan 18, 2010I'd love to hear what you think about GlassCalc! If you have a suggestion, find a bug, or just use GlassCalc, please leave a comment!
The actual software can be found here.
Direct your bug reports here. Feel free to talk about bugs below, but filling out a bug report gives me a better chance of finding and fixing bugs!