bitsdojo_window

To enable the package on Linux, modify linux/my_application.cc. Include the plugin header and use bitsdojo_window_from(window) to configure the window instance.

To use a custom frame, call bdw->setCustomFrame(true).

#include <bitsdojo_window_linux/bitsdojo_window_plugin.h>

// Inside your application setup:
auto bdw = bitsdojo_window_from(window);
bdw->setCustomFrame(true);

Add the bitsdojo_window package to your Flutter project's pubspec.yaml file using the following command:

pub add bitsdojo_window

To enable the package on Windows, modify windows/runner/main.cpp. You must include the plugin header and call bitsdojo_window_configure with the desired flags.

Available flags:

• BDW_CUSTOM_FRAME: Enables a custom window frame (removes standard titlebar and buttons).
• BDW_HIDE_ON_STARTUP: Hides the window when the application starts.

If you want to use the standard titlebar, remove BDW_CUSTOM_FRAME. If you want the window to be visible immediately, remove BDW_HIDE_ON_STARTUP.

#include <bitsdojo_window_windows/bitsdojo_window_plugin.h>
auto bdw = bitsdojo_window_configure(BDW_CUSTOM_FRAME | BDW_HIDE_ON_STARTUP);

To create a new platform-specific implementation for the bitsdojo_window plugin, you must extend the BitsdojoWindowPlatform class. Once your implementation is ready, you must register it as the default instance by assigning it to BitsdojoWindowPlatform.instance during your plugin registration process.

// 1. Extend BitsdojoWindowPlatform with your implementation
class MyPlatformBitsdojoWindow extends BitsdojoWindowPlatform {
  // Implement platform-specific behavior here
}

// 2. Register the implementation
BitsdojoWindowPlatform.instance = MyPlatformBitsdojoWindow();

To enable the package on macOS, modify macos/runner/MainFlutterWindow.swift. Change the class inheritance from NSWindow to BitsdojoWindow and override the bitsdojo_window_configure method.

Available flags:

• BDW_CUSTOM_FRAME: Enables a custom window frame.
• BDW_HIDE_ON_STARTUP: Hides the window when the application starts.

Example implementation:

import bitsdojo_window_macos

class MainFlutterWindow: BitsdojoWindow {
    override func bitsdojo_window_configure() -> UInt {
        return BDW_CUSTOM_FRAME | BDW_HIDE_ON_STARTUP
    }
}

import Cocoa
import FlutterMacOS
import bitsdojo_window_macos

class MainFlutterWindow: BitsdojoWindow {
    override func bitsdojo_window_configure() -> UInt {
        return BDW_CUSTOM_FRAME | BDW_HIDE_ON_STARTUP
    }
    override func awakeFromNib() {
        // ...
    }
}

The WindowButton widget allows you to create highly customizable title bar buttons (like minimize, maximize, or close) that respond to mouse states (hover, click).

It provides two builder patterns:

1. iconBuilder: A function to define how the icon looks based on the current WindowButtonContext (which includes mouseState and iconColor).
2. builder: A function to define the entire button's structure, receiving both the WindowButtonContext and the generated icon widget.

Note: WindowButton returns an empty Container on Web and macOS platforms.

WindowButton(
  iconBuilder: (buttonContext) => Icon(
    Icons.close,
    color: buttonContext.iconColor,
  ),
  onPressed: () => print('Button pressed!'),
  animate: true,
);

The library provides specialized subclasses of WindowButton that come with default icons and pre-configured actions for standard window management tasks. These buttons automatically interact with the appWindow instance.

• MinimizeWindowButton: Minimizes the window. Defaults to appWindow.minimize().
• MaximizeWindowButton: Maximizes or restores the window. Defaults to appWindow.maximizeOrRestore().
• RestoreWindowButton: Restores the window from a maximized state. Defaults to appWindow.maximizeOrRestore().
• CloseWindowButton: Closes the window. Defaults to appWindow.close(). Uses a specific default color scheme (reddish tones) for the hover/click states.

// Standard usage with default behaviors
Column(
  children: [
    MinimizeWindowButton(),
    MaximizeWindowButton(),
    CloseWindowButton(),
  ],
)

The bitsdojo_window package provides several pre-built StatelessWidget icons designed for window control bars (Minimize, Maximize, Restore, and Close). Each icon requires a color parameter to define its appearance.

Available icons:

• CloseIcon: An 'X' shaped icon.
• MaximizeIcon: A square icon representing a maximized window.
• RestoreIcon: An icon representing a window that can be restored from a maximized state.
• MinimizeIcon: A horizontal line icon representing a minimized window.

import 'package:bitsdojo_window/bitsdojo_window.dart'; // Or the specific path to icons
import 'package:flutter/material.dart';

// Example usage in a custom title bar
Row(
  children: [
    MinimizeIcon(color: Colors.black),
    MaximizeIcon(color: Colors.black),
    CloseIcon(color: Colors.red),
  ],
)

The application icon is defined in the Runner.rc file using the IDI_APP_ICON identifier. Ensure the icon file exists at the specified path relative to the resource directory.

IDI_APP_ICON            ICON                    "resources\\app_icon.ico"