diff --git a/CHANGELOG.md b/CHANGELOG.md index 69ac375..bc75918 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +## [3.0.0] - 2022-03-26 + +* Since all other functions have been merged in `ListTile`, +now this package is only used to get `TapDownDetails`. +* In this version, instead of rewriting `ListTile`, +we use a `Listener` to record the `PointerDownEvent` +for `onTap` and `onLongPress` to reach the target to +get the details similar to `TapDownDetails`. +* Migrate from an older version. +First, we should migrate from `TapDownDetails` to `PointerDownEvent`, +for example, from `details.globalPosition.dx` to `details.position.dx`. +Secondly, we need to change `ListTileMoreCustomizable...` (except `ListTileMoreCustomizable`) +into `ListTile...`, such as `ListTileMoreCustomizableTheme`, `ListTileMoreCustomizableStyle`, etc. +In most cases, just delete the `MoreCustomizable`, +and then the code will work fine. + ## [2.0.1] - 2021-08-16 * Fix `lib/list_tile_more_customizable.dart is not formatted according to dartfmt`. diff --git a/README.md b/README.md index 70d3496..b4bbc82 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This project is a modified version of Flutter ListTile, and provides more customizable functions, with these functions, you can set the horizontalTitleGap, minVerticalPadding, minLeadingWidth -and get the TapDownDetails when onTap or onLongPress occurred. +and get the PointerDownEvent when onTap or onLongPress occurred. ## Usage diff --git a/example/.gitignore b/example/.gitignore index ae1f183..0fa6b67 100644 --- a/example/.gitignore +++ b/example/.gitignore @@ -22,6 +22,7 @@ # Flutter/Dart/Pub related **/doc/api/ +**/ios/Flutter/.last_build_id .dart_tool/ .flutter-plugins .flutter-plugins-dependencies @@ -33,5 +34,13 @@ # Web related lib/generated_plugin_registrant.dart -# Exceptions to above rules. -!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages +# Symbolication related +app.*.symbols + +# Obfuscation related +app.*.map.json + +# Android Studio will place build artifacts here +/android/app/debug +/android/app/profile +/android/app/release diff --git a/example/.metadata b/example/.metadata index 611c9ed..55b337b 100644 --- a/example/.metadata +++ b/example/.metadata @@ -4,7 +4,7 @@ # This file should be version controlled and should not be manually edited. version: - revision: fabeb2a16f1d008ab8230f450c49141d35669798 - channel: beta + revision: 680962aa75a3c0ea8a55c57adc98944f5558bafd + channel: dev project_type: app diff --git a/example/README.md b/example/README.md index 5cde78c..28746d6 100644 --- a/example/README.md +++ b/example/README.md @@ -5,6 +5,6 @@ A list_tile_more_customizable flutter project example. ## Getting Started [Example](https://github.com/Playhi/list_tile_more_customizable/tree/master/example) for using list_tile_more_customizable. -For help getting started with Flutter, view Flutter -[online documentation](https://flutter.dev/docs), which offers tutorials, +For help getting started with Flutter development, view the +[online documentation](https://docs.flutter.dev/), which offers tutorials, samples, guidance on mobile development, and a full API reference. diff --git a/example/analysis_options.yaml b/example/analysis_options.yaml new file mode 100644 index 0000000..61b6c4d --- /dev/null +++ b/example/analysis_options.yaml @@ -0,0 +1,29 @@ +# This file configures the analyzer, which statically analyzes Dart code to +# check for errors, warnings, and lints. +# +# The issues identified by the analyzer are surfaced in the UI of Dart-enabled +# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be +# invoked from the command line by running `flutter analyze`. + +# The following line activates a set of recommended lints for Flutter apps, +# packages, and plugins designed to encourage good coding practices. +include: package:flutter_lints/flutter.yaml + +linter: + # The lint rules applied to this project can be customized in the + # section below to disable rules from the `package:flutter_lints/flutter.yaml` + # included above or to enable additional rules. A list of all available lints + # and their documentation is published at + # https://dart-lang.github.io/linter/lints/index.html. + # + # Instead of disabling a lint rule for the entire project in the + # section below, it can also be suppressed for a single line of code + # or a specific dart file by using the `// ignore: name_of_lint` and + # `// ignore_for_file: name_of_lint` syntax on the line or in the file + # producing the lint. + rules: + # avoid_print: false # Uncomment to disable the `avoid_print` rule + # prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule + +# Additional information about this file can be found at +# https://dart.dev/guides/language/analysis-options diff --git a/example/android/.gitignore b/example/android/.gitignore index bc2100d..6f56801 100644 --- a/example/android/.gitignore +++ b/example/android/.gitignore @@ -5,3 +5,9 @@ gradle-wrapper.jar /gradlew.bat /local.properties GeneratedPluginRegistrant.java + +# Remember to never publicly share your keystore. +# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app +key.properties +**/*.keystore +**/*.jks diff --git a/example/android/app/build.gradle b/example/android/app/build.gradle index 0f6a5e5..5f10ec3 100644 --- a/example/android/app/build.gradle +++ b/example/android/app/build.gradle @@ -26,24 +26,29 @@ apply plugin: 'kotlin-android' apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle" android { - compileSdkVersion 28 + compileSdkVersion flutter.compileSdkVersion + ndkVersion flutter.ndkVersion - sourceSets { - main.java.srcDirs += 'src/main/kotlin' + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + kotlinOptions { + jvmTarget = '1.8' } - lintOptions { - disable 'InvalidPackage' + sourceSets { + main.java.srcDirs += 'src/main/kotlin' } defaultConfig { // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html). applicationId "com.example.example" - minSdkVersion 16 - targetSdkVersion 28 + minSdkVersion flutter.minSdkVersion + targetSdkVersion flutter.targetSdkVersion versionCode flutterVersionCode.toInteger() versionName flutterVersionName - testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" } buildTypes { @@ -61,7 +66,4 @@ flutter { dependencies { implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" - testImplementation 'junit:junit:4.12' - androidTestImplementation 'androidx.test:runner:1.1.1' - androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1' } diff --git a/example/android/app/src/debug/AndroidManifest.xml b/example/android/app/src/debug/AndroidManifest.xml index c208884..45d523a 100644 --- a/example/android/app/src/debug/AndroidManifest.xml +++ b/example/android/app/src/debug/AndroidManifest.xml @@ -1,6 +1,7 @@ - diff --git a/example/android/app/src/main/AndroidManifest.xml b/example/android/app/src/main/AndroidManifest.xml index 55ca830..d7a695c 100644 --- a/example/android/app/src/main/AndroidManifest.xml +++ b/example/android/app/src/main/AndroidManifest.xml @@ -1,16 +1,12 @@ - - + + + + + + + diff --git a/example/android/app/src/main/res/values-night/styles.xml b/example/android/app/src/main/res/values-night/styles.xml new file mode 100644 index 0000000..06952be --- /dev/null +++ b/example/android/app/src/main/res/values-night/styles.xml @@ -0,0 +1,18 @@ + + + + + + + diff --git a/example/android/app/src/main/res/values/styles.xml b/example/android/app/src/main/res/values/styles.xml index 1f83a33..cb1ef88 100644 --- a/example/android/app/src/main/res/values/styles.xml +++ b/example/android/app/src/main/res/values/styles.xml @@ -1,18 +1,18 @@ - - - diff --git a/example/android/app/src/profile/AndroidManifest.xml b/example/android/app/src/profile/AndroidManifest.xml index c208884..45d523a 100644 --- a/example/android/app/src/profile/AndroidManifest.xml +++ b/example/android/app/src/profile/AndroidManifest.xml @@ -1,6 +1,7 @@ - diff --git a/example/android/build.gradle b/example/android/build.gradle index 3100ad2..4256f91 100644 --- a/example/android/build.gradle +++ b/example/android/build.gradle @@ -1,12 +1,12 @@ buildscript { - ext.kotlin_version = '1.3.50' + ext.kotlin_version = '1.6.10' repositories { google() - jcenter() + mavenCentral() } dependencies { - classpath 'com.android.tools.build:gradle:3.5.0' + classpath 'com.android.tools.build:gradle:4.1.0' classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" } } @@ -14,7 +14,7 @@ buildscript { allprojects { repositories { google() - jcenter() + mavenCentral() } } diff --git a/example/android/gradle.properties b/example/android/gradle.properties index 38c8d45..94adc3a 100644 --- a/example/android/gradle.properties +++ b/example/android/gradle.properties @@ -1,4 +1,3 @@ org.gradle.jvmargs=-Xmx1536M -android.enableR8=true android.useAndroidX=true android.enableJetifier=true diff --git a/example/android/gradle/wrapper/gradle-wrapper.properties b/example/android/gradle/wrapper/gradle-wrapper.properties index 296b146..bc6a58a 100644 --- a/example/android/gradle/wrapper/gradle-wrapper.properties +++ b/example/android/gradle/wrapper/gradle-wrapper.properties @@ -3,4 +3,4 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-all.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip diff --git a/example/android/settings.gradle b/example/android/settings.gradle index 5a2f14f..44e62bc 100644 --- a/example/android/settings.gradle +++ b/example/android/settings.gradle @@ -1,15 +1,11 @@ include ':app' -def flutterProjectRoot = rootProject.projectDir.parentFile.toPath() +def localPropertiesFile = new File(rootProject.projectDir, "local.properties") +def properties = new Properties() -def plugins = new Properties() -def pluginsFile = new File(flutterProjectRoot.toFile(), '.flutter-plugins') -if (pluginsFile.exists()) { - pluginsFile.withReader('UTF-8') { reader -> plugins.load(reader) } -} +assert localPropertiesFile.exists() +localPropertiesFile.withReader("UTF-8") { reader -> properties.load(reader) } -plugins.each { name, path -> - def pluginDirectory = flutterProjectRoot.resolve(path).resolve('android').toFile() - include ":$name" - project(":$name").projectDir = pluginDirectory -} +def flutterSdkPath = properties.getProperty("flutter.sdk") +assert flutterSdkPath != null, "flutter.sdk not set in local.properties" +apply from: "$flutterSdkPath/packages/flutter_tools/gradle/app_plugin_loader.gradle" diff --git a/example/ios/.gitignore b/example/ios/.gitignore index e96ef60..7a7f987 100644 --- a/example/ios/.gitignore +++ b/example/ios/.gitignore @@ -1,3 +1,4 @@ +**/dgph *.mode1v3 *.mode2v3 *.moved-aside @@ -18,6 +19,7 @@ Flutter/App.framework Flutter/Flutter.framework Flutter/Flutter.podspec Flutter/Generated.xcconfig +Flutter/ephemeral/ Flutter/app.flx Flutter/app.zip Flutter/flutter_assets/ diff --git a/example/ios/Flutter/AppFrameworkInfo.plist b/example/ios/Flutter/AppFrameworkInfo.plist index 6b4c0f7..8d4492f 100644 --- a/example/ios/Flutter/AppFrameworkInfo.plist +++ b/example/ios/Flutter/AppFrameworkInfo.plist @@ -3,7 +3,7 @@ CFBundleDevelopmentRegion - $(DEVELOPMENT_LANGUAGE) + en CFBundleExecutable App CFBundleIdentifier @@ -21,6 +21,6 @@ CFBundleVersion 1.0 MinimumOSVersion - 8.0 + 9.0 diff --git a/example/ios/Runner.xcodeproj/project.pbxproj b/example/ios/Runner.xcodeproj/project.pbxproj index bf347d8..6edd238 100644 --- a/example/ios/Runner.xcodeproj/project.pbxproj +++ b/example/ios/Runner.xcodeproj/project.pbxproj @@ -3,17 +3,13 @@ archiveVersion = 1; classes = { }; - objectVersion = 46; + objectVersion = 50; objects = { /* Begin PBXBuildFile section */ 1498D2341E8E89220040F4C2 /* GeneratedPluginRegistrant.m in Sources */ = {isa = PBXBuildFile; fileRef = 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */; }; 3B3967161E833CAA004F5970 /* AppFrameworkInfo.plist in Resources */ = {isa = PBXBuildFile; fileRef = 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */; }; - 3B80C3941E831B6300D905FE /* App.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3B80C3931E831B6300D905FE /* App.framework */; }; - 3B80C3951E831B6300D905FE /* App.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 3B80C3931E831B6300D905FE /* App.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; 74858FAF1ED2DC5600515810 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 74858FAE1ED2DC5600515810 /* AppDelegate.swift */; }; - 9705A1C61CF904A100538489 /* Flutter.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 9740EEBA1CF902C7004384FC /* Flutter.framework */; }; - 9705A1C71CF904A300538489 /* Flutter.framework in Embed Frameworks */ = {isa = PBXBuildFile; fileRef = 9740EEBA1CF902C7004384FC /* Flutter.framework */; settings = {ATTRIBUTES = (CodeSignOnCopy, RemoveHeadersOnCopy, ); }; }; 97C146FC1CF9000F007C117D /* Main.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FA1CF9000F007C117D /* Main.storyboard */; }; 97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FD1CF9000F007C117D /* Assets.xcassets */; }; 97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */; }; @@ -26,8 +22,6 @@ dstPath = ""; dstSubfolderSpec = 10; files = ( - 3B80C3951E831B6300D905FE /* App.framework in Embed Frameworks */, - 9705A1C71CF904A300538489 /* Flutter.framework in Embed Frameworks */, ); name = "Embed Frameworks"; runOnlyForDeploymentPostprocessing = 0; @@ -38,13 +32,11 @@ 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeneratedPluginRegistrant.h; sourceTree = ""; }; 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = GeneratedPluginRegistrant.m; sourceTree = ""; }; 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = AppFrameworkInfo.plist; path = Flutter/AppFrameworkInfo.plist; sourceTree = ""; }; - 3B80C3931E831B6300D905FE /* App.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = App.framework; path = Flutter/App.framework; sourceTree = ""; }; 74858FAD1ED2DC5600515810 /* Runner-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Runner-Bridging-Header.h"; sourceTree = ""; }; 74858FAE1ED2DC5600515810 /* AppDelegate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = ""; }; 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Debug.xcconfig; path = Flutter/Debug.xcconfig; sourceTree = ""; }; 9740EEB31CF90195004384FC /* Generated.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Generated.xcconfig; path = Flutter/Generated.xcconfig; sourceTree = ""; }; - 9740EEBA1CF902C7004384FC /* Flutter.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Flutter.framework; path = Flutter/Flutter.framework; sourceTree = ""; }; 97C146EE1CF9000F007C117D /* Runner.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Runner.app; sourceTree = BUILT_PRODUCTS_DIR; }; 97C146FB1CF9000F007C117D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/Main.storyboard; sourceTree = ""; }; 97C146FD1CF9000F007C117D /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = ""; }; @@ -57,8 +49,6 @@ isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( - 9705A1C61CF904A100538489 /* Flutter.framework in Frameworks */, - 3B80C3941E831B6300D905FE /* App.framework in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -68,9 +58,7 @@ 9740EEB11CF90186004384FC /* Flutter */ = { isa = PBXGroup; children = ( - 3B80C3931E831B6300D905FE /* App.framework */, 3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */, - 9740EEBA1CF902C7004384FC /* Flutter.framework */, 9740EEB21CF90195004384FC /* Debug.xcconfig */, 7AFA3C8E1D35360C0083082E /* Release.xcconfig */, 9740EEB31CF90195004384FC /* Generated.xcconfig */, @@ -102,7 +90,6 @@ 97C146FD1CF9000F007C117D /* Assets.xcassets */, 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */, 97C147021CF9000F007C117D /* Info.plist */, - 97C146F11CF9000F007C117D /* Supporting Files */, 1498D2321E8E86230040F4C2 /* GeneratedPluginRegistrant.h */, 1498D2331E8E89220040F4C2 /* GeneratedPluginRegistrant.m */, 74858FAE1ED2DC5600515810 /* AppDelegate.swift */, @@ -111,13 +98,6 @@ path = Runner; sourceTree = ""; }; - 97C146F11CF9000F007C117D /* Supporting Files */ = { - isa = PBXGroup; - children = ( - ); - name = "Supporting Files"; - sourceTree = ""; - }; /* End PBXGroup section */ /* Begin PBXNativeTarget section */ @@ -147,7 +127,7 @@ 97C146E61CF9000F007C117D /* Project object */ = { isa = PBXProject; attributes = { - LastUpgradeCheck = 1020; + LastUpgradeCheck = 1300; ORGANIZATIONNAME = ""; TargetAttributes = { 97C146ED1CF9000F007C117D = { @@ -157,7 +137,7 @@ }; }; buildConfigurationList = 97C146E91CF9000F007C117D /* Build configuration list for PBXProject "Runner" */; - compatibilityVersion = "Xcode 3.2"; + compatibilityVersion = "Xcode 9.3"; developmentRegion = en; hasScannedForEncodings = 0; knownRegions = ( @@ -201,7 +181,7 @@ ); runOnlyForDeploymentPostprocessing = 0; shellPath = /bin/sh; - shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" thin"; + shellScript = "/bin/sh \"$FLUTTER_ROOT/packages/flutter_tools/bin/xcode_backend.sh\" embed_and_thin"; }; 9740EEB61CF901F6004384FC /* Run Script */ = { isa = PBXShellScriptBuildPhase; @@ -253,7 +233,6 @@ /* Begin XCBuildConfiguration section */ 249021D3217E4FDB00AE95B9 /* Profile */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; CLANG_ANALYZER_NONNULL = YES; @@ -293,7 +272,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; + IPHONEOS_DEPLOYMENT_TARGET = 9.0; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = iphoneos; SUPPORTED_PLATFORMS = iphoneos; @@ -310,15 +289,10 @@ CLANG_ENABLE_MODULES = YES; CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; ENABLE_BITCODE = NO; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/Flutter", - ); INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - LIBRARY_SEARCH_PATHS = ( + LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", - "$(PROJECT_DIR)/Flutter", + "@executable_path/Frameworks", ); PRODUCT_BUNDLE_IDENTIFIER = com.example.example; PRODUCT_NAME = "$(TARGET_NAME)"; @@ -330,7 +304,6 @@ }; 97C147031CF9000F007C117D /* Debug */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 9740EEB21CF90195004384FC /* Debug.xcconfig */; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; CLANG_ANALYZER_NONNULL = YES; @@ -376,7 +349,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; + IPHONEOS_DEPLOYMENT_TARGET = 9.0; MTL_ENABLE_DEBUG_INFO = YES; ONLY_ACTIVE_ARCH = YES; SDKROOT = iphoneos; @@ -386,7 +359,6 @@ }; 97C147041CF9000F007C117D /* Release */ = { isa = XCBuildConfiguration; - baseConfigurationReference = 7AFA3C8E1D35360C0083082E /* Release.xcconfig */; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; CLANG_ANALYZER_NONNULL = YES; @@ -426,11 +398,12 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 8.0; + IPHONEOS_DEPLOYMENT_TARGET = 9.0; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = iphoneos; SUPPORTED_PLATFORMS = iphoneos; - SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule"; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; TARGETED_DEVICE_FAMILY = "1,2"; VALIDATE_PRODUCT = YES; }; @@ -444,15 +417,10 @@ CLANG_ENABLE_MODULES = YES; CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; ENABLE_BITCODE = NO; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/Flutter", - ); INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - LIBRARY_SEARCH_PATHS = ( + LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", - "$(PROJECT_DIR)/Flutter", + "@executable_path/Frameworks", ); PRODUCT_BUNDLE_IDENTIFIER = com.example.example; PRODUCT_NAME = "$(TARGET_NAME)"; @@ -471,15 +439,10 @@ CLANG_ENABLE_MODULES = YES; CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)"; ENABLE_BITCODE = NO; - FRAMEWORK_SEARCH_PATHS = ( - "$(inherited)", - "$(PROJECT_DIR)/Flutter", - ); INFOPLIST_FILE = Runner/Info.plist; - LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks"; - LIBRARY_SEARCH_PATHS = ( + LD_RUNPATH_SEARCH_PATHS = ( "$(inherited)", - "$(PROJECT_DIR)/Flutter", + "@executable_path/Frameworks", ); PRODUCT_BUNDLE_IDENTIFIER = com.example.example; PRODUCT_NAME = "$(TARGET_NAME)"; diff --git a/example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata index 1d526a1..919434a 100644 --- a/example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata +++ b/example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -2,6 +2,6 @@ + location = "self:"> diff --git a/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/example/ios/Runner.xcodeproj/project.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme index a28140c..c87d15a 100644 --- a/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +++ b/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -1,6 +1,6 @@ - - - - + + - - + + + + IDEDidComputeMac32BitWarning + + + diff --git a/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings new file mode 100644 index 0000000..f9b0d7c --- /dev/null +++ b/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings @@ -0,0 +1,8 @@ + + + + + PreviewsEnabled + + + diff --git a/example/ios/Runner/Info.plist b/example/ios/Runner/Info.plist index a060db6..5baf7a1 100644 --- a/example/ios/Runner/Info.plist +++ b/example/ios/Runner/Info.plist @@ -4,6 +4,8 @@ CFBundleDevelopmentRegion $(DEVELOPMENT_LANGUAGE) + CFBundleDisplayName + Example CFBundleExecutable $(EXECUTABLE_NAME) CFBundleIdentifier diff --git a/example/lib/main.dart b/example/lib/main.dart index 10d8f6c..d48380f 100644 --- a/example/lib/main.dart +++ b/example/lib/main.dart @@ -1,12 +1,17 @@ import 'package:flutter/material.dart'; import 'package:list_tile_more_customizable/list_tile_more_customizable.dart'; -void main() => runApp(MyApp()); +void main() { + runApp(const MyApp()); +} class MyApp extends StatelessWidget { + const MyApp({Key? key}) : super(key: key); + + // This widget is the root of your application. @override Widget build(BuildContext context) { - return MaterialApp( + return const MaterialApp( title: 'Flutter Demo', home: MyHomePage(title: 'Flutter Demo Home Page'), ); @@ -14,12 +19,12 @@ class MyApp extends StatelessWidget { } class MyHomePage extends StatefulWidget { - MyHomePage({Key? key, required this.title}) : super(key: key); + const MyHomePage({Key? key, required this.title}) : super(key: key); final String title; @override - _MyHomePageState createState() => _MyHomePageState(); + State createState() => _MyHomePageState(); } class _MyHomePageState extends State { @@ -35,21 +40,21 @@ class _MyHomePageState extends State { // A [ListTileMoreCustomizable] with [onTap], [onLongPress], // [leading], [title], [subtitle], [trailing]. ListTileMoreCustomizable( - leading: Icon(Icons.print), - title: Text("Title - 1"), - subtitle: Text("Subtitle - 1"), - trailing: Icon(Icons.account_balance), + leading: const Icon(Icons.print), + title: const Text("Title - 1"), + subtitle: const Text("Subtitle - 1"), + trailing: const Icon(Icons.account_balance), onTap: (details) { showMenu( context: context, position: RelativeRect.fromLTRB( - details.globalPosition.dx, - details.globalPosition.dy, - details.globalPosition.dx, - details.globalPosition.dy, + details.position.dx, + details.position.dy, + details.position.dx, + details.position.dy, ), items: >[ - PopupMenuItem(child: Text("onTap - 1!")), + const PopupMenuItem(child: Text("onTap - 1!")), ], ); }, @@ -57,89 +62,89 @@ class _MyHomePageState extends State { showMenu( context: context, position: RelativeRect.fromLTRB( - details.globalPosition.dx, - details.globalPosition.dy, - details.globalPosition.dx, - details.globalPosition.dy, + details.position.dx, + details.position.dy, + details.position.dx, + details.position.dy, ), items: >[ - PopupMenuItem(child: Text("onLongPressed - 1!")), + const PopupMenuItem(child: Text("onLongPressed - 1!")), ], ); }, ), - Divider(), + const Divider(), // A [ListTileMoreCustomizable] with [onLongPress], // [leading], [title], [subtitle], // [trailing], [horizontalTitleGap]. ListTileMoreCustomizable( - leading: Icon(Icons.priority_high), - title: Text("Title - 2"), - subtitle: Text("Subtitle - 2"), - trailing: Icon(Icons.palette), + leading: const Icon(Icons.priority_high), + title: const Text("Title - 2"), + subtitle: const Text("Subtitle - 2"), + trailing: const Icon(Icons.palette), onLongPress: (details) { showMenu( context: context, position: RelativeRect.fromLTRB( - details.globalPosition.dx, - details.globalPosition.dy, - details.globalPosition.dx, - details.globalPosition.dy, + details.position.dx, + details.position.dy, + details.position.dx, + details.position.dy, ), items: >[ - PopupMenuItem(child: Text("onLongPress - 2!")), + const PopupMenuItem(child: Text("onLongPress - 2!")), ], ); }, horizontalTitleGap: 0.0, ), - Divider(), + const Divider(), // A [ListTileMoreCustomizable] with [onTap], // [leading], [title], // [trailing], [horizontalTitleGap]. ListTileMoreCustomizable( - leading: Icon(Icons.schedule), - title: Text("Title - 3"), - trailing: Icon(Icons.ac_unit), + leading: const Icon(Icons.schedule), + title: const Text("Title - 3"), + trailing: const Icon(Icons.ac_unit), onTap: (details) { showMenu( context: context, position: RelativeRect.fromLTRB( - details.globalPosition.dx, - details.globalPosition.dy, - details.globalPosition.dx, - details.globalPosition.dy, + details.position.dx, + details.position.dy, + details.position.dx, + details.position.dy, ), items: >[ - PopupMenuItem(child: Text("onTap - 3!")), + const PopupMenuItem(child: Text("onTap - 3!")), ], ); }, horizontalTitleGap: 0.0, ), - Divider(), + const Divider(), // A [ListTileMoreCustomizable] with [onTap], // [leading], [title], [trailing]. ListTileMoreCustomizable( - leading: Icon(Icons.palette), - title: Text("Title - 4"), - trailing: Icon(Icons.title), + leading: const Icon(Icons.palette), + title: const Text("Title - 4"), + trailing: const Icon(Icons.title), onTap: (details) { showMenu( context: context, position: RelativeRect.fromLTRB( - details.globalPosition.dx, - details.globalPosition.dy, - details.globalPosition.dx, - details.globalPosition.dy, + details.position.dx, + details.position.dy, + details.position.dx, + details.position.dy, ), items: >[ - PopupMenuItem(child: Text("onTap - 4!")), + const PopupMenuItem(child: Text("onTap - 4!")), ], ); }, ), - Divider(), + const Divider(), ], ), ), diff --git a/example/linux/.gitignore b/example/linux/.gitignore new file mode 100644 index 0000000..d3896c9 --- /dev/null +++ b/example/linux/.gitignore @@ -0,0 +1 @@ +flutter/ephemeral diff --git a/example/linux/CMakeLists.txt b/example/linux/CMakeLists.txt new file mode 100644 index 0000000..74c66dd --- /dev/null +++ b/example/linux/CMakeLists.txt @@ -0,0 +1,138 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.10) +project(runner LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "example") +# The unique GTK application identifier for this application. See: +# https://wiki.gnome.org/HowDoI/ChooseApplicationID +set(APPLICATION_ID "com.example.example") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Load bundled libraries from the lib/ directory relative to the binary. +set(CMAKE_INSTALL_RPATH "$ORIGIN/lib") + +# Root filesystem for cross-building. +if(FLUTTER_TARGET_PLATFORM_SYSROOT) + set(CMAKE_SYSROOT ${FLUTTER_TARGET_PLATFORM_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH ${CMAKE_SYSROOT}) + set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) + set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) +endif() + +# Define build configuration options. +if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") +endif() + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_14) + target_compile_options(${TARGET} PRIVATE -Wall -Werror) + target_compile_options(${TARGET} PRIVATE "$<$>:-O3>") + target_compile_definitions(${TARGET} PRIVATE "$<$>:NDEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) + +add_definitions(-DAPPLICATION_ID="${APPLICATION_ID}") + +# Define the application target. To change its name, change BINARY_NAME above, +# not the value here, or `flutter run` will no longer work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} + "main.cc" + "my_application.cc" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Add dependency libraries. Add any application-specific dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter) +target_link_libraries(${BINARY_NAME} PRIVATE PkgConfig::GTK) + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) + +# Only the install-generated bundle's copy of the executable will launch +# correctly, since the resources must in the right relative locations. To avoid +# people trying to run the unbundled copy, put it in a subdirectory instead of +# the default top-level location. +set_target_properties(${BINARY_NAME} + PROPERTIES + RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/intermediates_do_not_run" +) + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# By default, "installing" just makes a relocatable bundle in the build +# directory. +set(BUILD_BUNDLE_DIR "${PROJECT_BINARY_DIR}/bundle") +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +# Start with a clean build bundle directory every time. +install(CODE " + file(REMOVE_RECURSE \"${BUILD_BUNDLE_DIR}/\") + " COMPONENT Runtime) + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +foreach(bundled_library ${PLUGIN_BUNDLED_LIBRARIES}) + install(FILES "${bundled_library}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endforeach(bundled_library) + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +if(NOT CMAKE_BUILD_TYPE MATCHES "Debug") + install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() diff --git a/example/linux/flutter/CMakeLists.txt b/example/linux/flutter/CMakeLists.txt new file mode 100644 index 0000000..d5bd016 --- /dev/null +++ b/example/linux/flutter/CMakeLists.txt @@ -0,0 +1,88 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.10) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. + +# Serves the same purpose as list(TRANSFORM ... PREPEND ...), +# which isn't available in 3.10. +function(list_prepend LIST_NAME PREFIX) + set(NEW_LIST "") + foreach(element ${${LIST_NAME}}) + list(APPEND NEW_LIST "${PREFIX}${element}") + endforeach(element) + set(${LIST_NAME} "${NEW_LIST}" PARENT_SCOPE) +endfunction() + +# === Flutter Library === +# System-level dependencies. +find_package(PkgConfig REQUIRED) +pkg_check_modules(GTK REQUIRED IMPORTED_TARGET gtk+-3.0) +pkg_check_modules(GLIB REQUIRED IMPORTED_TARGET glib-2.0) +pkg_check_modules(GIO REQUIRED IMPORTED_TARGET gio-2.0) + +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/libflutter_linux_gtk.so") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/lib/libapp.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "fl_basic_message_channel.h" + "fl_binary_codec.h" + "fl_binary_messenger.h" + "fl_dart_project.h" + "fl_engine.h" + "fl_json_message_codec.h" + "fl_json_method_codec.h" + "fl_message_codec.h" + "fl_method_call.h" + "fl_method_channel.h" + "fl_method_codec.h" + "fl_method_response.h" + "fl_plugin_registrar.h" + "fl_plugin_registry.h" + "fl_standard_message_codec.h" + "fl_standard_method_codec.h" + "fl_string_codec.h" + "fl_value.h" + "fl_view.h" + "flutter_linux.h" +) +list_prepend(FLUTTER_LIBRARY_HEADERS "${EPHEMERAL_DIR}/flutter_linux/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}") +target_link_libraries(flutter INTERFACE + PkgConfig::GTK + PkgConfig::GLIB + PkgConfig::GIO +) +add_dependencies(flutter flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CMAKE_CURRENT_BINARY_DIR}/_phony_ + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.sh" + ${FLUTTER_TARGET_PLATFORM} ${CMAKE_BUILD_TYPE} + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} +) diff --git a/example/linux/flutter/generated_plugin_registrant.cc b/example/linux/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..e71a16d --- /dev/null +++ b/example/linux/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void fl_register_plugins(FlPluginRegistry* registry) { +} diff --git a/example/linux/flutter/generated_plugin_registrant.h b/example/linux/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..e0f0a47 --- /dev/null +++ b/example/linux/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void fl_register_plugins(FlPluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/linux/flutter/generated_plugins.cmake b/example/linux/flutter/generated_plugins.cmake new file mode 100644 index 0000000..2e1de87 --- /dev/null +++ b/example/linux/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/linux plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/linux plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/example/linux/main.cc b/example/linux/main.cc new file mode 100644 index 0000000..e7c5c54 --- /dev/null +++ b/example/linux/main.cc @@ -0,0 +1,6 @@ +#include "my_application.h" + +int main(int argc, char** argv) { + g_autoptr(MyApplication) app = my_application_new(); + return g_application_run(G_APPLICATION(app), argc, argv); +} diff --git a/example/linux/my_application.cc b/example/linux/my_application.cc new file mode 100644 index 0000000..0ba8f43 --- /dev/null +++ b/example/linux/my_application.cc @@ -0,0 +1,104 @@ +#include "my_application.h" + +#include +#ifdef GDK_WINDOWING_X11 +#include +#endif + +#include "flutter/generated_plugin_registrant.h" + +struct _MyApplication { + GtkApplication parent_instance; + char** dart_entrypoint_arguments; +}; + +G_DEFINE_TYPE(MyApplication, my_application, GTK_TYPE_APPLICATION) + +// Implements GApplication::activate. +static void my_application_activate(GApplication* application) { + MyApplication* self = MY_APPLICATION(application); + GtkWindow* window = + GTK_WINDOW(gtk_application_window_new(GTK_APPLICATION(application))); + + // Use a header bar when running in GNOME as this is the common style used + // by applications and is the setup most users will be using (e.g. Ubuntu + // desktop). + // If running on X and not using GNOME then just use a traditional title bar + // in case the window manager does more exotic layout, e.g. tiling. + // If running on Wayland assume the header bar will work (may need changing + // if future cases occur). + gboolean use_header_bar = TRUE; +#ifdef GDK_WINDOWING_X11 + GdkScreen* screen = gtk_window_get_screen(window); + if (GDK_IS_X11_SCREEN(screen)) { + const gchar* wm_name = gdk_x11_screen_get_window_manager_name(screen); + if (g_strcmp0(wm_name, "GNOME Shell") != 0) { + use_header_bar = FALSE; + } + } +#endif + if (use_header_bar) { + GtkHeaderBar* header_bar = GTK_HEADER_BAR(gtk_header_bar_new()); + gtk_widget_show(GTK_WIDGET(header_bar)); + gtk_header_bar_set_title(header_bar, "example"); + gtk_header_bar_set_show_close_button(header_bar, TRUE); + gtk_window_set_titlebar(window, GTK_WIDGET(header_bar)); + } else { + gtk_window_set_title(window, "example"); + } + + gtk_window_set_default_size(window, 1280, 720); + gtk_widget_show(GTK_WIDGET(window)); + + g_autoptr(FlDartProject) project = fl_dart_project_new(); + fl_dart_project_set_dart_entrypoint_arguments(project, self->dart_entrypoint_arguments); + + FlView* view = fl_view_new(project); + gtk_widget_show(GTK_WIDGET(view)); + gtk_container_add(GTK_CONTAINER(window), GTK_WIDGET(view)); + + fl_register_plugins(FL_PLUGIN_REGISTRY(view)); + + gtk_widget_grab_focus(GTK_WIDGET(view)); +} + +// Implements GApplication::local_command_line. +static gboolean my_application_local_command_line(GApplication* application, gchar*** arguments, int* exit_status) { + MyApplication* self = MY_APPLICATION(application); + // Strip out the first argument as it is the binary name. + self->dart_entrypoint_arguments = g_strdupv(*arguments + 1); + + g_autoptr(GError) error = nullptr; + if (!g_application_register(application, nullptr, &error)) { + g_warning("Failed to register: %s", error->message); + *exit_status = 1; + return TRUE; + } + + g_application_activate(application); + *exit_status = 0; + + return TRUE; +} + +// Implements GObject::dispose. +static void my_application_dispose(GObject* object) { + MyApplication* self = MY_APPLICATION(object); + g_clear_pointer(&self->dart_entrypoint_arguments, g_strfreev); + G_OBJECT_CLASS(my_application_parent_class)->dispose(object); +} + +static void my_application_class_init(MyApplicationClass* klass) { + G_APPLICATION_CLASS(klass)->activate = my_application_activate; + G_APPLICATION_CLASS(klass)->local_command_line = my_application_local_command_line; + G_OBJECT_CLASS(klass)->dispose = my_application_dispose; +} + +static void my_application_init(MyApplication* self) {} + +MyApplication* my_application_new() { + return MY_APPLICATION(g_object_new(my_application_get_type(), + "application-id", APPLICATION_ID, + "flags", G_APPLICATION_NON_UNIQUE, + nullptr)); +} diff --git a/example/linux/my_application.h b/example/linux/my_application.h new file mode 100644 index 0000000..72271d5 --- /dev/null +++ b/example/linux/my_application.h @@ -0,0 +1,18 @@ +#ifndef FLUTTER_MY_APPLICATION_H_ +#define FLUTTER_MY_APPLICATION_H_ + +#include + +G_DECLARE_FINAL_TYPE(MyApplication, my_application, MY, APPLICATION, + GtkApplication) + +/** + * my_application_new: + * + * Creates a new Flutter-based application. + * + * Returns: a new #MyApplication. + */ +MyApplication* my_application_new(); + +#endif // FLUTTER_MY_APPLICATION_H_ diff --git a/example/pubspec.lock b/example/pubspec.lock index 690ebf3..d3cff99 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -5,56 +5,56 @@ packages: dependency: transitive description: name: async - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "2.8.1" + version: "2.8.2" boolean_selector: dependency: transitive description: name: boolean_selector - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "2.1.0" characters: dependency: transitive description: name: characters - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "1.1.0" + version: "1.2.0" charcode: dependency: transitive description: name: charcode - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.3.1" clock: dependency: transitive description: name: clock - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.1.0" collection: dependency: transitive description: name: collection - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.15.0" cupertino_icons: dependency: "direct main" description: name: cupertino_icons - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "0.1.3" + version: "1.0.4" fake_async: dependency: transitive description: name: fake_async - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.2.0" flutter: @@ -62,39 +62,53 @@ packages: description: flutter source: sdk version: "0.0.0" + flutter_lints: + dependency: "direct dev" + description: + name: flutter_lints + url: "https://pub.dartlang.org" + source: hosted + version: "1.0.4" flutter_test: dependency: "direct dev" description: flutter source: sdk version: "0.0.0" - list_tile_more_customizable: - dependency: "direct main" + lints: + dependency: transitive description: - name: list_tile_more_customizable - url: "https://pub.flutter-io.cn" + name: lints + url: "https://pub.dartlang.org" source: hosted - version: "2.0.1" + version: "1.0.1" matcher: dependency: transitive description: name: matcher - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "0.12.10" + version: "0.12.11" + material_color_utilities: + dependency: transitive + description: + name: material_color_utilities + url: "https://pub.dartlang.org" + source: hosted + version: "0.1.4" meta: dependency: transitive description: name: meta - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.7.0" path: dependency: transitive description: name: path - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "1.8.0" + version: "1.8.1" sky_engine: dependency: transitive description: flutter @@ -104,57 +118,57 @@ packages: dependency: transitive description: name: source_span - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "1.8.1" + version: "1.8.2" stack_trace: dependency: transitive description: name: stack_trace - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.10.0" stream_channel: dependency: transitive description: name: stream_channel - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "2.1.0" string_scanner: dependency: transitive description: name: string_scanner - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.1.0" term_glyph: dependency: transitive description: name: term_glyph - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.2.0" test_api: dependency: transitive description: name: test_api - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "0.4.2" + version: "0.4.9" typed_data: dependency: transitive description: name: typed_data - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.3.0" vector_math: dependency: transitive description: name: vector_math - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "2.1.0" + version: "2.1.2" sdks: - dart: ">=2.12.0 <3.0.0" + dart: ">=2.14.0 <3.0.0" diff --git a/example/pubspec.yaml b/example/pubspec.yaml index d210958..0dc54c4 100644 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -1,6 +1,10 @@ name: list_tile_more_customizable_example description: A list_tile_more_customizable flutter project example. +# The following line prevents the package from being accidentally published to +# pub.dev using `flutter pub publish`. This is preferred for private packages. +publish_to: 'none' # Remove this line if you wish to publish to pub.dev + # The following defines the version and build number for your application. # A version number is three numbers separated by dots, like 1.2.43 # followed by an optional build number separated by a +. @@ -16,25 +20,37 @@ version: 1.0.0+1 environment: sdk: ">=2.12.0 <3.0.0" +# Dependencies specify other packages that your package needs in order to work. +# To automatically upgrade your package dependencies to the latest versions +# consider running `flutter pub upgrade --major-versions`. Alternatively, +# dependencies can be manually updated by changing the version numbers below to +# the latest version available on pub.dev. To see which dependencies have newer +# versions available, run `flutter pub outdated`. dependencies: flutter: sdk: flutter - list_tile_more_customizable: ^2.0.1 + list_tile_more_customizable: ^3.0.0 # The following adds the Cupertino Icons font to your application. # Use with the CupertinoIcons class for iOS style icons. - cupertino_icons: ^0.1.3 + cupertino_icons: ^1.0.2 dev_dependencies: flutter_test: sdk: flutter + # The "flutter_lints" package below contains a set of recommended lints to + # encourage good coding practices. The lint set provided by the package is + # activated in the `analysis_options.yaml` file located at the root of your + # package. See that file for information about deactivating specific lint + # rules and activating additional ones. + flutter_lints: ^1.0.0 # For information on the generic Dart part of this file, see the # following page: https://dart.dev/tools/pub/pubspec -# The following section is specific to Flutter. +# The following section is specific to Flutter packages. flutter: # The following line ensures that the Material Icons font is diff --git a/example/test/widget_test.dart b/example/test/widget_test.dart index 1cdd5e5..d3a40ab 100644 --- a/example/test/widget_test.dart +++ b/example/test/widget_test.dart @@ -1,19 +1,18 @@ // This is a basic Flutter widget test. // // To perform an interaction with a widget in your test, use the WidgetTester -// utility that Flutter provides. For example, you can send tap and scroll +// utility in the flutter_test package. For example, you can send tap and scroll // gestures. You can also use WidgetTester to find child widgets in the widget // tree, read text, and verify that the values of widget properties are correct. import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart'; - import 'package:list_tile_more_customizable_example/main.dart'; void main() { testWidgets('Counter increments smoke test', (WidgetTester tester) async { // Build our app and trigger a frame. - await tester.pumpWidget(MyApp()); + await tester.pumpWidget(const MyApp()); // Verify that our counter starts at 0. expect(find.text('0'), findsOneWidget); diff --git a/example/web/favicon.png b/example/web/favicon.png new file mode 100644 index 0000000..8aaa46a Binary files /dev/null and b/example/web/favicon.png differ diff --git a/example/web/icons/Icon-maskable-192.png b/example/web/icons/Icon-maskable-192.png new file mode 100644 index 0000000..eb9b4d7 Binary files /dev/null and b/example/web/icons/Icon-maskable-192.png differ diff --git a/example/web/icons/Icon-maskable-512.png b/example/web/icons/Icon-maskable-512.png new file mode 100644 index 0000000..d69c566 Binary files /dev/null and b/example/web/icons/Icon-maskable-512.png differ diff --git a/example/web/index.html b/example/web/index.html index 6169f0b..3453b1b 100644 --- a/example/web/index.html +++ b/example/web/index.html @@ -1,30 +1,104 @@ + + + - + - + + + + example - + - diff --git a/example/web/manifest.json b/example/web/manifest.json index f731211..6465045 100644 --- a/example/web/manifest.json +++ b/example/web/manifest.json @@ -2,7 +2,7 @@ "name": "example", "short_name": "example", "start_url": ".", - "display": "minimal-ui", + "display": "standalone", "background_color": "#0175C2", "theme_color": "#0175C2", "description": "A list_tile_more_customizable flutter project example.", @@ -18,6 +18,18 @@ "src": "icons/Icon-512.png", "sizes": "512x512", "type": "image/png" + }, + { + "src": "icons/Icon-maskable-192.png", + "sizes": "192x192", + "type": "image/png", + "purpose": "maskable" + }, + { + "src": "icons/Icon-maskable-512.png", + "sizes": "512x512", + "type": "image/png", + "purpose": "maskable" } ] } diff --git a/example/windows/.gitignore b/example/windows/.gitignore new file mode 100644 index 0000000..d492d0d --- /dev/null +++ b/example/windows/.gitignore @@ -0,0 +1,17 @@ +flutter/ephemeral/ + +# Visual Studio user-specific files. +*.suo +*.user +*.userosscache +*.sln.docstates + +# Visual Studio build-related files. +x64/ +x86/ + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ diff --git a/example/windows/CMakeLists.txt b/example/windows/CMakeLists.txt new file mode 100644 index 0000000..c027074 --- /dev/null +++ b/example/windows/CMakeLists.txt @@ -0,0 +1,101 @@ +# Project-level configuration. +cmake_minimum_required(VERSION 3.14) +project(example LANGUAGES CXX) + +# The name of the executable created for the application. Change this to change +# the on-disk name of your application. +set(BINARY_NAME "example") + +# Explicitly opt in to modern CMake behaviors to avoid warnings with recent +# versions of CMake. +cmake_policy(SET CMP0063 NEW) + +# Define build configuration option. +get_property(IS_MULTICONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) +if(IS_MULTICONFIG) + set(CMAKE_CONFIGURATION_TYPES "Debug;Profile;Release" + CACHE STRING "" FORCE) +else() + if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES) + set(CMAKE_BUILD_TYPE "Debug" CACHE + STRING "Flutter build mode" FORCE) + set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS + "Debug" "Profile" "Release") + endif() +endif() +# Define settings for the Profile build mode. +set(CMAKE_EXE_LINKER_FLAGS_PROFILE "${CMAKE_EXE_LINKER_FLAGS_RELEASE}") +set(CMAKE_SHARED_LINKER_FLAGS_PROFILE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE}") +set(CMAKE_C_FLAGS_PROFILE "${CMAKE_C_FLAGS_RELEASE}") +set(CMAKE_CXX_FLAGS_PROFILE "${CMAKE_CXX_FLAGS_RELEASE}") + +# Use Unicode for all projects. +add_definitions(-DUNICODE -D_UNICODE) + +# Compilation settings that should be applied to most targets. +# +# Be cautious about adding new options here, as plugins use this function by +# default. In most cases, you should add new options to specific targets instead +# of modifying this function. +function(APPLY_STANDARD_SETTINGS TARGET) + target_compile_features(${TARGET} PUBLIC cxx_std_17) + target_compile_options(${TARGET} PRIVATE /W4 /WX /wd"4100") + target_compile_options(${TARGET} PRIVATE /EHsc) + target_compile_definitions(${TARGET} PRIVATE "_HAS_EXCEPTIONS=0") + target_compile_definitions(${TARGET} PRIVATE "$<$:_DEBUG>") +endfunction() + +# Flutter library and tool build rules. +set(FLUTTER_MANAGED_DIR "${CMAKE_CURRENT_SOURCE_DIR}/flutter") +add_subdirectory(${FLUTTER_MANAGED_DIR}) + +# Application build; see runner/CMakeLists.txt. +add_subdirectory("runner") + +# Generated plugin build rules, which manage building the plugins and adding +# them to the application. +include(flutter/generated_plugins.cmake) + + +# === Installation === +# Support files are copied into place next to the executable, so that it can +# run in place. This is done instead of making a separate bundle (as on Linux) +# so that building and running from within Visual Studio will work. +set(BUILD_BUNDLE_DIR "$") +# Make the "install" step default, as it's required to run. +set(CMAKE_VS_INCLUDE_INSTALL_TO_DEFAULT_BUILD 1) +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) + set(CMAKE_INSTALL_PREFIX "${BUILD_BUNDLE_DIR}" CACHE PATH "..." FORCE) +endif() + +set(INSTALL_BUNDLE_DATA_DIR "${CMAKE_INSTALL_PREFIX}/data") +set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}") + +install(TARGETS ${BINARY_NAME} RUNTIME DESTINATION "${CMAKE_INSTALL_PREFIX}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_ICU_DATA_FILE}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + COMPONENT Runtime) + +install(FILES "${FLUTTER_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) + +if(PLUGIN_BUNDLED_LIBRARIES) + install(FILES "${PLUGIN_BUNDLED_LIBRARIES}" + DESTINATION "${INSTALL_BUNDLE_LIB_DIR}" + COMPONENT Runtime) +endif() + +# Fully re-copy the assets directory on each build to avoid having stale files +# from a previous install. +set(FLUTTER_ASSET_DIR_NAME "flutter_assets") +install(CODE " + file(REMOVE_RECURSE \"${INSTALL_BUNDLE_DATA_DIR}/${FLUTTER_ASSET_DIR_NAME}\") + " COMPONENT Runtime) +install(DIRECTORY "${PROJECT_BUILD_DIR}/${FLUTTER_ASSET_DIR_NAME}" + DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" COMPONENT Runtime) + +# Install the AOT library on non-Debug builds only. +install(FILES "${AOT_LIBRARY}" DESTINATION "${INSTALL_BUNDLE_DATA_DIR}" + CONFIGURATIONS Profile;Release + COMPONENT Runtime) diff --git a/example/windows/flutter/CMakeLists.txt b/example/windows/flutter/CMakeLists.txt new file mode 100644 index 0000000..930d207 --- /dev/null +++ b/example/windows/flutter/CMakeLists.txt @@ -0,0 +1,104 @@ +# This file controls Flutter-level build steps. It should not be edited. +cmake_minimum_required(VERSION 3.14) + +set(EPHEMERAL_DIR "${CMAKE_CURRENT_SOURCE_DIR}/ephemeral") + +# Configuration provided via flutter tool. +include(${EPHEMERAL_DIR}/generated_config.cmake) + +# TODO: Move the rest of this into files in ephemeral. See +# https://github.com/flutter/flutter/issues/57146. +set(WRAPPER_ROOT "${EPHEMERAL_DIR}/cpp_client_wrapper") + +# === Flutter Library === +set(FLUTTER_LIBRARY "${EPHEMERAL_DIR}/flutter_windows.dll") + +# Published to parent scope for install step. +set(FLUTTER_LIBRARY ${FLUTTER_LIBRARY} PARENT_SCOPE) +set(FLUTTER_ICU_DATA_FILE "${EPHEMERAL_DIR}/icudtl.dat" PARENT_SCOPE) +set(PROJECT_BUILD_DIR "${PROJECT_DIR}/build/" PARENT_SCOPE) +set(AOT_LIBRARY "${PROJECT_DIR}/build/windows/app.so" PARENT_SCOPE) + +list(APPEND FLUTTER_LIBRARY_HEADERS + "flutter_export.h" + "flutter_windows.h" + "flutter_messenger.h" + "flutter_plugin_registrar.h" + "flutter_texture_registrar.h" +) +list(TRANSFORM FLUTTER_LIBRARY_HEADERS PREPEND "${EPHEMERAL_DIR}/") +add_library(flutter INTERFACE) +target_include_directories(flutter INTERFACE + "${EPHEMERAL_DIR}" +) +target_link_libraries(flutter INTERFACE "${FLUTTER_LIBRARY}.lib") +add_dependencies(flutter flutter_assemble) + +# === Wrapper === +list(APPEND CPP_WRAPPER_SOURCES_CORE + "core_implementations.cc" + "standard_codec.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_CORE PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_PLUGIN + "plugin_registrar.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_PLUGIN PREPEND "${WRAPPER_ROOT}/") +list(APPEND CPP_WRAPPER_SOURCES_APP + "flutter_engine.cc" + "flutter_view_controller.cc" +) +list(TRANSFORM CPP_WRAPPER_SOURCES_APP PREPEND "${WRAPPER_ROOT}/") + +# Wrapper sources needed for a plugin. +add_library(flutter_wrapper_plugin STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} +) +apply_standard_settings(flutter_wrapper_plugin) +set_target_properties(flutter_wrapper_plugin PROPERTIES + POSITION_INDEPENDENT_CODE ON) +set_target_properties(flutter_wrapper_plugin PROPERTIES + CXX_VISIBILITY_PRESET hidden) +target_link_libraries(flutter_wrapper_plugin PUBLIC flutter) +target_include_directories(flutter_wrapper_plugin PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_plugin flutter_assemble) + +# Wrapper sources needed for the runner. +add_library(flutter_wrapper_app STATIC + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_APP} +) +apply_standard_settings(flutter_wrapper_app) +target_link_libraries(flutter_wrapper_app PUBLIC flutter) +target_include_directories(flutter_wrapper_app PUBLIC + "${WRAPPER_ROOT}/include" +) +add_dependencies(flutter_wrapper_app flutter_assemble) + +# === Flutter tool backend === +# _phony_ is a non-existent file to force this command to run every time, +# since currently there's no way to get a full input/output list from the +# flutter tool. +set(PHONY_OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/_phony_") +set_source_files_properties("${PHONY_OUTPUT}" PROPERTIES SYMBOLIC TRUE) +add_custom_command( + OUTPUT ${FLUTTER_LIBRARY} ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} + ${PHONY_OUTPUT} + COMMAND ${CMAKE_COMMAND} -E env + ${FLUTTER_TOOL_ENVIRONMENT} + "${FLUTTER_ROOT}/packages/flutter_tools/bin/tool_backend.bat" + windows-x64 $ + VERBATIM +) +add_custom_target(flutter_assemble DEPENDS + "${FLUTTER_LIBRARY}" + ${FLUTTER_LIBRARY_HEADERS} + ${CPP_WRAPPER_SOURCES_CORE} + ${CPP_WRAPPER_SOURCES_PLUGIN} + ${CPP_WRAPPER_SOURCES_APP} +) diff --git a/example/windows/flutter/generated_plugin_registrant.cc b/example/windows/flutter/generated_plugin_registrant.cc new file mode 100644 index 0000000..8b6d468 --- /dev/null +++ b/example/windows/flutter/generated_plugin_registrant.cc @@ -0,0 +1,11 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#include "generated_plugin_registrant.h" + + +void RegisterPlugins(flutter::PluginRegistry* registry) { +} diff --git a/example/windows/flutter/generated_plugin_registrant.h b/example/windows/flutter/generated_plugin_registrant.h new file mode 100644 index 0000000..dc139d8 --- /dev/null +++ b/example/windows/flutter/generated_plugin_registrant.h @@ -0,0 +1,15 @@ +// +// Generated file. Do not edit. +// + +// clang-format off + +#ifndef GENERATED_PLUGIN_REGISTRANT_ +#define GENERATED_PLUGIN_REGISTRANT_ + +#include + +// Registers Flutter plugins. +void RegisterPlugins(flutter::PluginRegistry* registry); + +#endif // GENERATED_PLUGIN_REGISTRANT_ diff --git a/example/windows/flutter/generated_plugins.cmake b/example/windows/flutter/generated_plugins.cmake new file mode 100644 index 0000000..b93c4c3 --- /dev/null +++ b/example/windows/flutter/generated_plugins.cmake @@ -0,0 +1,23 @@ +# +# Generated file, do not edit. +# + +list(APPEND FLUTTER_PLUGIN_LIST +) + +list(APPEND FLUTTER_FFI_PLUGIN_LIST +) + +set(PLUGIN_BUNDLED_LIBRARIES) + +foreach(plugin ${FLUTTER_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${plugin}/windows plugins/${plugin}) + target_link_libraries(${BINARY_NAME} PRIVATE ${plugin}_plugin) + list(APPEND PLUGIN_BUNDLED_LIBRARIES $) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${plugin}_bundled_libraries}) +endforeach(plugin) + +foreach(ffi_plugin ${FLUTTER_FFI_PLUGIN_LIST}) + add_subdirectory(flutter/ephemeral/.plugin_symlinks/${ffi_plugin}/windows plugins/${ffi_plugin}) + list(APPEND PLUGIN_BUNDLED_LIBRARIES ${${ffi_plugin}_bundled_libraries}) +endforeach(ffi_plugin) diff --git a/example/windows/runner/CMakeLists.txt b/example/windows/runner/CMakeLists.txt new file mode 100644 index 0000000..b9e550f --- /dev/null +++ b/example/windows/runner/CMakeLists.txt @@ -0,0 +1,32 @@ +cmake_minimum_required(VERSION 3.14) +project(runner LANGUAGES CXX) + +# Define the application target. To change its name, change BINARY_NAME in the +# top-level CMakeLists.txt, not the value here, or `flutter run` will no longer +# work. +# +# Any new source files that you add to the application should be added here. +add_executable(${BINARY_NAME} WIN32 + "flutter_window.cpp" + "main.cpp" + "utils.cpp" + "win32_window.cpp" + "${FLUTTER_MANAGED_DIR}/generated_plugin_registrant.cc" + "Runner.rc" + "runner.exe.manifest" +) + +# Apply the standard set of build settings. This can be removed for applications +# that need different build settings. +apply_standard_settings(${BINARY_NAME}) + +# Disable Windows macros that collide with C++ standard library functions. +target_compile_definitions(${BINARY_NAME} PRIVATE "NOMINMAX") + +# Add dependency libraries and include directories. Add any application-specific +# dependencies here. +target_link_libraries(${BINARY_NAME} PRIVATE flutter flutter_wrapper_app) +target_include_directories(${BINARY_NAME} PRIVATE "${CMAKE_SOURCE_DIR}") + +# Run the Flutter tool portions of the build. This must not be removed. +add_dependencies(${BINARY_NAME} flutter_assemble) diff --git a/example/windows/runner/Runner.rc b/example/windows/runner/Runner.rc new file mode 100644 index 0000000..5fdea29 --- /dev/null +++ b/example/windows/runner/Runner.rc @@ -0,0 +1,121 @@ +// Microsoft Visual C++ generated resource script. +// +#pragma code_page(65001) +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 2 resource. +// +#include "winres.h" + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (United States) resources + +#if !defined(AFX_RESOURCE_DLL) || defined(AFX_TARG_ENU) +LANGUAGE LANG_ENGLISH, SUBLANG_ENGLISH_US + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" +END + +2 TEXTINCLUDE +BEGIN + "#include ""winres.h""\r\n" + "\0" +END + +3 TEXTINCLUDE +BEGIN + "\r\n" + "\0" +END + +#endif // APSTUDIO_INVOKED + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon with lowest ID value placed first to ensure application icon +// remains consistent on all systems. +IDI_APP_ICON ICON "resources\\app_icon.ico" + + +///////////////////////////////////////////////////////////////////////////// +// +// Version +// + +#ifdef FLUTTER_BUILD_NUMBER +#define VERSION_AS_NUMBER FLUTTER_BUILD_NUMBER +#else +#define VERSION_AS_NUMBER 1,0,0 +#endif + +#ifdef FLUTTER_BUILD_NAME +#define VERSION_AS_STRING #FLUTTER_BUILD_NAME +#else +#define VERSION_AS_STRING "1.0.0" +#endif + +VS_VERSION_INFO VERSIONINFO + FILEVERSION VERSION_AS_NUMBER + PRODUCTVERSION VERSION_AS_NUMBER + FILEFLAGSMASK VS_FFI_FILEFLAGSMASK +#ifdef _DEBUG + FILEFLAGS VS_FF_DEBUG +#else + FILEFLAGS 0x0L +#endif + FILEOS VOS__WINDOWS32 + FILETYPE VFT_APP + FILESUBTYPE 0x0L +BEGIN + BLOCK "StringFileInfo" + BEGIN + BLOCK "040904e4" + BEGIN + VALUE "CompanyName", "com.example" "\0" + VALUE "FileDescription", "example" "\0" + VALUE "FileVersion", VERSION_AS_STRING "\0" + VALUE "InternalName", "example" "\0" + VALUE "LegalCopyright", "Copyright (C) 2022 com.example. All rights reserved." "\0" + VALUE "OriginalFilename", "example.exe" "\0" + VALUE "ProductName", "example" "\0" + VALUE "ProductVersion", VERSION_AS_STRING "\0" + END + END + BLOCK "VarFileInfo" + BEGIN + VALUE "Translation", 0x409, 1252 + END +END + +#endif // English (United States) resources +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED diff --git a/example/windows/runner/flutter_window.cpp b/example/windows/runner/flutter_window.cpp new file mode 100644 index 0000000..b43b909 --- /dev/null +++ b/example/windows/runner/flutter_window.cpp @@ -0,0 +1,61 @@ +#include "flutter_window.h" + +#include + +#include "flutter/generated_plugin_registrant.h" + +FlutterWindow::FlutterWindow(const flutter::DartProject& project) + : project_(project) {} + +FlutterWindow::~FlutterWindow() {} + +bool FlutterWindow::OnCreate() { + if (!Win32Window::OnCreate()) { + return false; + } + + RECT frame = GetClientArea(); + + // The size here must match the window dimensions to avoid unnecessary surface + // creation / destruction in the startup path. + flutter_controller_ = std::make_unique( + frame.right - frame.left, frame.bottom - frame.top, project_); + // Ensure that basic setup of the controller was successful. + if (!flutter_controller_->engine() || !flutter_controller_->view()) { + return false; + } + RegisterPlugins(flutter_controller_->engine()); + SetChildContent(flutter_controller_->view()->GetNativeWindow()); + return true; +} + +void FlutterWindow::OnDestroy() { + if (flutter_controller_) { + flutter_controller_ = nullptr; + } + + Win32Window::OnDestroy(); +} + +LRESULT +FlutterWindow::MessageHandler(HWND hwnd, UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + // Give Flutter, including plugins, an opportunity to handle window messages. + if (flutter_controller_) { + std::optional result = + flutter_controller_->HandleTopLevelWindowProc(hwnd, message, wparam, + lparam); + if (result) { + return *result; + } + } + + switch (message) { + case WM_FONTCHANGE: + flutter_controller_->engine()->ReloadSystemFonts(); + break; + } + + return Win32Window::MessageHandler(hwnd, message, wparam, lparam); +} diff --git a/example/windows/runner/flutter_window.h b/example/windows/runner/flutter_window.h new file mode 100644 index 0000000..6da0652 --- /dev/null +++ b/example/windows/runner/flutter_window.h @@ -0,0 +1,33 @@ +#ifndef RUNNER_FLUTTER_WINDOW_H_ +#define RUNNER_FLUTTER_WINDOW_H_ + +#include +#include + +#include + +#include "win32_window.h" + +// A window that does nothing but host a Flutter view. +class FlutterWindow : public Win32Window { + public: + // Creates a new FlutterWindow hosting a Flutter view running |project|. + explicit FlutterWindow(const flutter::DartProject& project); + virtual ~FlutterWindow(); + + protected: + // Win32Window: + bool OnCreate() override; + void OnDestroy() override; + LRESULT MessageHandler(HWND window, UINT const message, WPARAM const wparam, + LPARAM const lparam) noexcept override; + + private: + // The project to run. + flutter::DartProject project_; + + // The Flutter instance hosted by this window. + std::unique_ptr flutter_controller_; +}; + +#endif // RUNNER_FLUTTER_WINDOW_H_ diff --git a/example/windows/runner/main.cpp b/example/windows/runner/main.cpp new file mode 100644 index 0000000..bcb57b0 --- /dev/null +++ b/example/windows/runner/main.cpp @@ -0,0 +1,43 @@ +#include +#include +#include + +#include "flutter_window.h" +#include "utils.h" + +int APIENTRY wWinMain(_In_ HINSTANCE instance, _In_opt_ HINSTANCE prev, + _In_ wchar_t *command_line, _In_ int show_command) { + // Attach to console when present (e.g., 'flutter run') or create a + // new console when running with a debugger. + if (!::AttachConsole(ATTACH_PARENT_PROCESS) && ::IsDebuggerPresent()) { + CreateAndAttachConsole(); + } + + // Initialize COM, so that it is available for use in the library and/or + // plugins. + ::CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); + + flutter::DartProject project(L"data"); + + std::vector command_line_arguments = + GetCommandLineArguments(); + + project.set_dart_entrypoint_arguments(std::move(command_line_arguments)); + + FlutterWindow window(project); + Win32Window::Point origin(10, 10); + Win32Window::Size size(1280, 720); + if (!window.CreateAndShow(L"example", origin, size)) { + return EXIT_FAILURE; + } + window.SetQuitOnClose(true); + + ::MSG msg; + while (::GetMessage(&msg, nullptr, 0, 0)) { + ::TranslateMessage(&msg); + ::DispatchMessage(&msg); + } + + ::CoUninitialize(); + return EXIT_SUCCESS; +} diff --git a/example/windows/runner/resource.h b/example/windows/runner/resource.h new file mode 100644 index 0000000..66a65d1 --- /dev/null +++ b/example/windows/runner/resource.h @@ -0,0 +1,16 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by Runner.rc +// +#define IDI_APP_ICON 101 + +// Next default values for new objects +// +#ifdef APSTUDIO_INVOKED +#ifndef APSTUDIO_READONLY_SYMBOLS +#define _APS_NEXT_RESOURCE_VALUE 102 +#define _APS_NEXT_COMMAND_VALUE 40001 +#define _APS_NEXT_CONTROL_VALUE 1001 +#define _APS_NEXT_SYMED_VALUE 101 +#endif +#endif diff --git a/example/windows/runner/resources/app_icon.ico b/example/windows/runner/resources/app_icon.ico new file mode 100644 index 0000000..c04e20c Binary files /dev/null and b/example/windows/runner/resources/app_icon.ico differ diff --git a/example/windows/runner/runner.exe.manifest b/example/windows/runner/runner.exe.manifest new file mode 100644 index 0000000..c977c4a --- /dev/null +++ b/example/windows/runner/runner.exe.manifest @@ -0,0 +1,20 @@ + + + + + PerMonitorV2 + + + + + + + + + + + + + + + diff --git a/example/windows/runner/utils.cpp b/example/windows/runner/utils.cpp new file mode 100644 index 0000000..d19bdbb --- /dev/null +++ b/example/windows/runner/utils.cpp @@ -0,0 +1,64 @@ +#include "utils.h" + +#include +#include +#include +#include + +#include + +void CreateAndAttachConsole() { + if (::AllocConsole()) { + FILE *unused; + if (freopen_s(&unused, "CONOUT$", "w", stdout)) { + _dup2(_fileno(stdout), 1); + } + if (freopen_s(&unused, "CONOUT$", "w", stderr)) { + _dup2(_fileno(stdout), 2); + } + std::ios::sync_with_stdio(); + FlutterDesktopResyncOutputStreams(); + } +} + +std::vector GetCommandLineArguments() { + // Convert the UTF-16 command line arguments to UTF-8 for the Engine to use. + int argc; + wchar_t** argv = ::CommandLineToArgvW(::GetCommandLineW(), &argc); + if (argv == nullptr) { + return std::vector(); + } + + std::vector command_line_arguments; + + // Skip the first argument as it's the binary name. + for (int i = 1; i < argc; i++) { + command_line_arguments.push_back(Utf8FromUtf16(argv[i])); + } + + ::LocalFree(argv); + + return command_line_arguments; +} + +std::string Utf8FromUtf16(const wchar_t* utf16_string) { + if (utf16_string == nullptr) { + return std::string(); + } + int target_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, nullptr, 0, nullptr, nullptr); + if (target_length == 0) { + return std::string(); + } + std::string utf8_string; + utf8_string.resize(target_length); + int converted_length = ::WideCharToMultiByte( + CP_UTF8, WC_ERR_INVALID_CHARS, utf16_string, + -1, utf8_string.data(), + target_length, nullptr, nullptr); + if (converted_length == 0) { + return std::string(); + } + return utf8_string; +} diff --git a/example/windows/runner/utils.h b/example/windows/runner/utils.h new file mode 100644 index 0000000..3879d54 --- /dev/null +++ b/example/windows/runner/utils.h @@ -0,0 +1,19 @@ +#ifndef RUNNER_UTILS_H_ +#define RUNNER_UTILS_H_ + +#include +#include + +// Creates a console for the process, and redirects stdout and stderr to +// it for both the runner and the Flutter library. +void CreateAndAttachConsole(); + +// Takes a null-terminated wchar_t* encoded in UTF-16 and returns a std::string +// encoded in UTF-8. Returns an empty std::string on failure. +std::string Utf8FromUtf16(const wchar_t* utf16_string); + +// Gets the command line arguments passed in as a std::vector, +// encoded in UTF-8. Returns an empty std::vector on failure. +std::vector GetCommandLineArguments(); + +#endif // RUNNER_UTILS_H_ diff --git a/example/windows/runner/win32_window.cpp b/example/windows/runner/win32_window.cpp new file mode 100644 index 0000000..c10f08d --- /dev/null +++ b/example/windows/runner/win32_window.cpp @@ -0,0 +1,245 @@ +#include "win32_window.h" + +#include + +#include "resource.h" + +namespace { + +constexpr const wchar_t kWindowClassName[] = L"FLUTTER_RUNNER_WIN32_WINDOW"; + +// The number of Win32Window objects that currently exist. +static int g_active_window_count = 0; + +using EnableNonClientDpiScaling = BOOL __stdcall(HWND hwnd); + +// Scale helper to convert logical scaler values to physical using passed in +// scale factor +int Scale(int source, double scale_factor) { + return static_cast(source * scale_factor); +} + +// Dynamically loads the |EnableNonClientDpiScaling| from the User32 module. +// This API is only needed for PerMonitor V1 awareness mode. +void EnableFullDpiSupportIfAvailable(HWND hwnd) { + HMODULE user32_module = LoadLibraryA("User32.dll"); + if (!user32_module) { + return; + } + auto enable_non_client_dpi_scaling = + reinterpret_cast( + GetProcAddress(user32_module, "EnableNonClientDpiScaling")); + if (enable_non_client_dpi_scaling != nullptr) { + enable_non_client_dpi_scaling(hwnd); + FreeLibrary(user32_module); + } +} + +} // namespace + +// Manages the Win32Window's window class registration. +class WindowClassRegistrar { + public: + ~WindowClassRegistrar() = default; + + // Returns the singleton registar instance. + static WindowClassRegistrar* GetInstance() { + if (!instance_) { + instance_ = new WindowClassRegistrar(); + } + return instance_; + } + + // Returns the name of the window class, registering the class if it hasn't + // previously been registered. + const wchar_t* GetWindowClass(); + + // Unregisters the window class. Should only be called if there are no + // instances of the window. + void UnregisterWindowClass(); + + private: + WindowClassRegistrar() = default; + + static WindowClassRegistrar* instance_; + + bool class_registered_ = false; +}; + +WindowClassRegistrar* WindowClassRegistrar::instance_ = nullptr; + +const wchar_t* WindowClassRegistrar::GetWindowClass() { + if (!class_registered_) { + WNDCLASS window_class{}; + window_class.hCursor = LoadCursor(nullptr, IDC_ARROW); + window_class.lpszClassName = kWindowClassName; + window_class.style = CS_HREDRAW | CS_VREDRAW; + window_class.cbClsExtra = 0; + window_class.cbWndExtra = 0; + window_class.hInstance = GetModuleHandle(nullptr); + window_class.hIcon = + LoadIcon(window_class.hInstance, MAKEINTRESOURCE(IDI_APP_ICON)); + window_class.hbrBackground = 0; + window_class.lpszMenuName = nullptr; + window_class.lpfnWndProc = Win32Window::WndProc; + RegisterClass(&window_class); + class_registered_ = true; + } + return kWindowClassName; +} + +void WindowClassRegistrar::UnregisterWindowClass() { + UnregisterClass(kWindowClassName, nullptr); + class_registered_ = false; +} + +Win32Window::Win32Window() { + ++g_active_window_count; +} + +Win32Window::~Win32Window() { + --g_active_window_count; + Destroy(); +} + +bool Win32Window::CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size) { + Destroy(); + + const wchar_t* window_class = + WindowClassRegistrar::GetInstance()->GetWindowClass(); + + const POINT target_point = {static_cast(origin.x), + static_cast(origin.y)}; + HMONITOR monitor = MonitorFromPoint(target_point, MONITOR_DEFAULTTONEAREST); + UINT dpi = FlutterDesktopGetDpiForMonitor(monitor); + double scale_factor = dpi / 96.0; + + HWND window = CreateWindow( + window_class, title.c_str(), WS_OVERLAPPEDWINDOW | WS_VISIBLE, + Scale(origin.x, scale_factor), Scale(origin.y, scale_factor), + Scale(size.width, scale_factor), Scale(size.height, scale_factor), + nullptr, nullptr, GetModuleHandle(nullptr), this); + + if (!window) { + return false; + } + + return OnCreate(); +} + +// static +LRESULT CALLBACK Win32Window::WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + if (message == WM_NCCREATE) { + auto window_struct = reinterpret_cast(lparam); + SetWindowLongPtr(window, GWLP_USERDATA, + reinterpret_cast(window_struct->lpCreateParams)); + + auto that = static_cast(window_struct->lpCreateParams); + EnableFullDpiSupportIfAvailable(window); + that->window_handle_ = window; + } else if (Win32Window* that = GetThisFromHandle(window)) { + return that->MessageHandler(window, message, wparam, lparam); + } + + return DefWindowProc(window, message, wparam, lparam); +} + +LRESULT +Win32Window::MessageHandler(HWND hwnd, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept { + switch (message) { + case WM_DESTROY: + window_handle_ = nullptr; + Destroy(); + if (quit_on_close_) { + PostQuitMessage(0); + } + return 0; + + case WM_DPICHANGED: { + auto newRectSize = reinterpret_cast(lparam); + LONG newWidth = newRectSize->right - newRectSize->left; + LONG newHeight = newRectSize->bottom - newRectSize->top; + + SetWindowPos(hwnd, nullptr, newRectSize->left, newRectSize->top, newWidth, + newHeight, SWP_NOZORDER | SWP_NOACTIVATE); + + return 0; + } + case WM_SIZE: { + RECT rect = GetClientArea(); + if (child_content_ != nullptr) { + // Size and position the child window. + MoveWindow(child_content_, rect.left, rect.top, rect.right - rect.left, + rect.bottom - rect.top, TRUE); + } + return 0; + } + + case WM_ACTIVATE: + if (child_content_ != nullptr) { + SetFocus(child_content_); + } + return 0; + } + + return DefWindowProc(window_handle_, message, wparam, lparam); +} + +void Win32Window::Destroy() { + OnDestroy(); + + if (window_handle_) { + DestroyWindow(window_handle_); + window_handle_ = nullptr; + } + if (g_active_window_count == 0) { + WindowClassRegistrar::GetInstance()->UnregisterWindowClass(); + } +} + +Win32Window* Win32Window::GetThisFromHandle(HWND const window) noexcept { + return reinterpret_cast( + GetWindowLongPtr(window, GWLP_USERDATA)); +} + +void Win32Window::SetChildContent(HWND content) { + child_content_ = content; + SetParent(content, window_handle_); + RECT frame = GetClientArea(); + + MoveWindow(content, frame.left, frame.top, frame.right - frame.left, + frame.bottom - frame.top, true); + + SetFocus(child_content_); +} + +RECT Win32Window::GetClientArea() { + RECT frame; + GetClientRect(window_handle_, &frame); + return frame; +} + +HWND Win32Window::GetHandle() { + return window_handle_; +} + +void Win32Window::SetQuitOnClose(bool quit_on_close) { + quit_on_close_ = quit_on_close; +} + +bool Win32Window::OnCreate() { + // No-op; provided for subclasses. + return true; +} + +void Win32Window::OnDestroy() { + // No-op; provided for subclasses. +} diff --git a/example/windows/runner/win32_window.h b/example/windows/runner/win32_window.h new file mode 100644 index 0000000..17ba431 --- /dev/null +++ b/example/windows/runner/win32_window.h @@ -0,0 +1,98 @@ +#ifndef RUNNER_WIN32_WINDOW_H_ +#define RUNNER_WIN32_WINDOW_H_ + +#include + +#include +#include +#include + +// A class abstraction for a high DPI-aware Win32 Window. Intended to be +// inherited from by classes that wish to specialize with custom +// rendering and input handling +class Win32Window { + public: + struct Point { + unsigned int x; + unsigned int y; + Point(unsigned int x, unsigned int y) : x(x), y(y) {} + }; + + struct Size { + unsigned int width; + unsigned int height; + Size(unsigned int width, unsigned int height) + : width(width), height(height) {} + }; + + Win32Window(); + virtual ~Win32Window(); + + // Creates and shows a win32 window with |title| and position and size using + // |origin| and |size|. New windows are created on the default monitor. Window + // sizes are specified to the OS in physical pixels, hence to ensure a + // consistent size to will treat the width height passed in to this function + // as logical pixels and scale to appropriate for the default monitor. Returns + // true if the window was created successfully. + bool CreateAndShow(const std::wstring& title, + const Point& origin, + const Size& size); + + // Release OS resources associated with window. + void Destroy(); + + // Inserts |content| into the window tree. + void SetChildContent(HWND content); + + // Returns the backing Window handle to enable clients to set icon and other + // window properties. Returns nullptr if the window has been destroyed. + HWND GetHandle(); + + // If true, closing this window will quit the application. + void SetQuitOnClose(bool quit_on_close); + + // Return a RECT representing the bounds of the current client area. + RECT GetClientArea(); + + protected: + // Processes and route salient window messages for mouse handling, + // size change and DPI. Delegates handling of these to member overloads that + // inheriting classes can handle. + virtual LRESULT MessageHandler(HWND window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Called when CreateAndShow is called, allowing subclass window-related + // setup. Subclasses should return false if setup fails. + virtual bool OnCreate(); + + // Called when Destroy is called. + virtual void OnDestroy(); + + private: + friend class WindowClassRegistrar; + + // OS callback called by message pump. Handles the WM_NCCREATE message which + // is passed when the non-client area is being created and enables automatic + // non-client DPI scaling so that the non-client area automatically + // responsponds to changes in DPI. All other messages are handled by + // MessageHandler. + static LRESULT CALLBACK WndProc(HWND const window, + UINT const message, + WPARAM const wparam, + LPARAM const lparam) noexcept; + + // Retrieves a class instance pointer for |window| + static Win32Window* GetThisFromHandle(HWND const window) noexcept; + + bool quit_on_close_ = false; + + // window handle for top level window. + HWND window_handle_ = nullptr; + + // window handle for hosted content. + HWND child_content_ = nullptr; +}; + +#endif // RUNNER_WIN32_WINDOW_H_ diff --git a/lib/list_tile_more_customizable.dart b/lib/list_tile_more_customizable.dart index 2d79656..815db7a 100644 --- a/lib/list_tile_more_customizable.dart +++ b/lib/list_tile_more_customizable.dart @@ -4,750 +4,12 @@ library list_tile_more_customizable; // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE_RAW_FLUTTER file. -// This file has been modified based on The Flutter Authors' version, -// which can be found in https://github.com/flutter/flutter/blob/06be7e5392f657fda8e7098f9bafdc02bab672e4/packages/flutter/lib/src/material/list_tile.dart, -// which has been used as the initial version of this file. - // Copyright 2020 The List Tile More Customizable Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -import 'dart:math' as math; - import 'package:flutter/material.dart'; -import 'package:flutter/widgets.dart'; -import 'package:flutter/foundation.dart'; -import 'package:flutter/rendering.dart'; - -/// Defines the title font used for [ListTileMoreCustomizable] descendants of a [ListTileMoreCustomizableTheme]. -/// -/// List tiles that appear in a [Drawer] use the theme's [TextTheme.bodyText1] -/// text style, which is a little smaller than the theme's [TextTheme.subtitle1] -/// text style, which is used by default. -enum ListTileMoreCustomizableStyle { - /// Use a title font that's appropriate for a [ListTileMoreCustomizable] in a list. - list, - - /// Use a title font that's appropriate for a [ListTileMoreCustomizable] that appears in a [Drawer]. - drawer, -} - -/// An inherited widget that defines color and style parameters for [ListTileMoreCustomizable]s -/// in this widget's subtree. -/// -/// Values specified here are used for [ListTileMoreCustomizable] properties that are not given -/// an explicit non-null value. -/// -/// The [Drawer] widget specifies a tile theme for its children which sets -/// [style] to [ListTileMoreCustomizableStyle.drawer]. -class ListTileMoreCustomizableTheme extends InheritedTheme { - /// Creates a list tile theme that controls the color and style parameters for - /// [ListTileMoreCustomizable]s. - const ListTileMoreCustomizableTheme({ - Key? key, - this.dense = false, - this.shape, - this.style = ListTileMoreCustomizableStyle.list, - this.selectedColor, - this.iconColor, - this.textColor, - this.contentPadding, - this.tileColor, - this.selectedTileColor, - this.enableFeedback, - this.horizontalTitleGap, - this.minVerticalPadding, - this.minLeadingWidth, - required Widget child, - }) : super(key: key, child: child); - - /// Creates a list tile theme that controls the color and style parameters for - /// [ListTileMoreCustomizable]s, and merges in the current list tile theme, if any. - /// - /// The [child] argument must not be null. - static Widget merge({ - Key? key, - bool? dense, - ShapeBorder? shape, - ListTileMoreCustomizableStyle? style, - Color? selectedColor, - Color? iconColor, - Color? textColor, - EdgeInsetsGeometry? contentPadding, - Color? tileColor, - Color? selectedTileColor, - bool? enableFeedback, - double? horizontalTitleGap, - double? minVerticalPadding, - double? minLeadingWidth, - required Widget child, - }) { - assert(child != null); - return Builder( - builder: (BuildContext context) { - final ListTileMoreCustomizableTheme parent = - ListTileMoreCustomizableTheme.of(context); - return ListTileMoreCustomizableTheme( - key: key, - dense: dense ?? parent.dense, - shape: shape ?? parent.shape, - style: style ?? parent.style, - selectedColor: selectedColor ?? parent.selectedColor, - iconColor: iconColor ?? parent.iconColor, - textColor: textColor ?? parent.textColor, - contentPadding: contentPadding ?? parent.contentPadding, - tileColor: tileColor ?? parent.tileColor, - selectedTileColor: selectedTileColor ?? parent.selectedTileColor, - enableFeedback: enableFeedback ?? parent.enableFeedback, - horizontalTitleGap: horizontalTitleGap ?? parent.horizontalTitleGap, - minVerticalPadding: minVerticalPadding ?? parent.minVerticalPadding, - minLeadingWidth: minLeadingWidth ?? parent.minLeadingWidth, - child: child, - ); - }, - ); - } - - /// If true then [ListTileMoreCustomizable]s will have the vertically dense layout. - final bool dense; - - /// {@template flutter.material.ListTileMoreCustomizableTheme.shape} - /// If specified, [shape] defines the [ListTileMoreCustomizable]'s shape. - /// {@endtemplate} - final ShapeBorder? shape; - - /// If specified, [style] defines the font used for [ListTileMoreCustomizable] titles. - final ListTileMoreCustomizableStyle style; - - /// If specified, the color used for icons and text when a [ListTileMoreCustomizable] is selected. - final Color? selectedColor; - - /// If specified, the icon color used for enabled [ListTileMoreCustomizable]s that are not selected. - final Color? iconColor; - - /// If specified, the text color used for enabled [ListTileMoreCustomizable]s that are not selected. - final Color? textColor; - - /// The tile's internal padding. - /// - /// Insets a [ListTileMoreCustomizable]'s contents: its [ListTileMoreCustomizable.leading], [ListTileMoreCustomizable.title], - /// [ListTileMoreCustomizable.subtitle], and [ListTileMoreCustomizable.trailing] widgets. - final EdgeInsetsGeometry? contentPadding; - - /// If specified, defines the background color for `ListTileMoreCustomizable` when - /// [ListTileMoreCustomizable.selected] is false. - /// - /// If [ListTileMoreCustomizable.tileColor] is provided, [tileColor] is ignored. - final Color? tileColor; - /// If specified, defines the background color for `ListTileMoreCustomizable` when - /// [ListTileMoreCustomizable.selected] is true. - /// - /// If [ListTileMoreCustomizable.selectedTileColor] is provided, [selectedTileColor] is ignored. - final Color? selectedTileColor; - - /// The horizontal gap between the titles and the leading/trailing widgets. - /// - /// If specified, overrides the default value of [ListTileMoreCustomizable.horizontalTitleGap]. - final double? horizontalTitleGap; - - /// The minimum padding on the top and bottom of the title and subtitle widgets. - /// - /// If specified, overrides the default value of [ListTileMoreCustomizable.minVerticalPadding]. - final double? minVerticalPadding; - - /// The minimum width allocated for the [ListTileMoreCustomizable.leading] widget. - /// - /// If specified, overrides the default value of [ListTileMoreCustomizable.minLeadingWidth]. - final double? minLeadingWidth; - - /// If specified, defines the feedback property for `ListTileMoreCustomizable`. - /// - /// If [ListTileMoreCustomizable.enableFeedback] is provided, [enableFeedback] is ignored. - final bool? enableFeedback; - - /// The closest instance of this class that encloses the given context. - /// - /// Typical usage is as follows: - /// - /// ```dart - /// ListTileMoreCustomizableTheme theme = ListTileMoreCustomizableTheme.of(context); - /// ``` - static ListTileMoreCustomizableTheme of(BuildContext context) { - final ListTileMoreCustomizableTheme? result = context - .dependOnInheritedWidgetOfExactType(); - return result ?? const ListTileMoreCustomizableTheme(child: SizedBox()); - } - - @override - Widget wrap(BuildContext context, Widget child) { - return ListTileMoreCustomizableTheme( - dense: dense, - shape: shape, - style: style, - selectedColor: selectedColor, - iconColor: iconColor, - textColor: textColor, - contentPadding: contentPadding, - tileColor: tileColor, - selectedTileColor: selectedTileColor, - enableFeedback: enableFeedback, - horizontalTitleGap: horizontalTitleGap, - minVerticalPadding: minVerticalPadding, - minLeadingWidth: minLeadingWidth, - child: child, - ); - } - - @override - bool updateShouldNotify(ListTileMoreCustomizableTheme oldWidget) { - return dense != oldWidget.dense || - shape != oldWidget.shape || - style != oldWidget.style || - selectedColor != oldWidget.selectedColor || - iconColor != oldWidget.iconColor || - textColor != oldWidget.textColor || - contentPadding != oldWidget.contentPadding || - tileColor != oldWidget.tileColor || - selectedTileColor != oldWidget.selectedTileColor || - enableFeedback != oldWidget.enableFeedback || - horizontalTitleGap != oldWidget.horizontalTitleGap || - minVerticalPadding != oldWidget.minVerticalPadding || - minLeadingWidth != oldWidget.minLeadingWidth; - } -} - -/// Where to place the control in widgets that use [ListTileMoreCustomizable] to position a -/// control next to a label. -/// -/// See also: -/// -/// * [CheckboxListTile], which combines a [ListTileMoreCustomizable] with a [Checkbox]. -/// * [RadioListTile], which combines a [ListTileMoreCustomizable] with a [Radio] button. -/// * [SwitchListTile], which combines a [ListTile] with a [Switch]. -/// * [ExpansionTile], which combines a [ListTile] with a button that expands -/// or collapses the tile to reveal or hide the children. -enum ListTileMoreCustomizableControlAffinity { - /// Position the control on the leading edge, and the secondary widget, if - /// any, on the trailing edge. - leading, - - /// Position the control on the trailing edge, and the secondary widget, if - /// any, on the leading edge. - trailing, - - /// Position the control relative to the text in the fashion that is typical - /// for the current platform, and place the secondary widget on the opposite - /// side. - platform, -} - -/// A single fixed-height row that typically contains some text as well as -/// a leading or trailing icon. -/// -/// {@youtube 560 315 https://www.youtube.com/watch?v=l8dj0yPBvgQ} -/// -/// A list tile contains one to three lines of text optionally flanked by icons or -/// other widgets, such as check boxes. The icons (or other widgets) for the -/// tile are defined with the [leading] and [trailing] parameters. The first -/// line of text is not optional and is specified with [title]. The value of -/// [subtitle], which _is_ optional, will occupy the space allocated for an -/// additional line of text, or two lines if [isThreeLine] is true. If [dense] -/// is true then the overall height of this tile and the size of the -/// [DefaultTextStyle]s that wrap the [title] and [subtitle] widget are reduced. -/// -/// It is the responsibility of the caller to ensure that [title] does not wrap, -/// and to ensure that [subtitle] doesn't wrap (if [isThreeLine] is false) or -/// wraps to two lines (if it is true). -/// -/// The heights of the [leading] and [trailing] widgets are constrained -/// according to the -/// [Material spec](https://material.io/design/components/lists.html). -/// An exception is made for one-line ListTiles for accessibility. Please -/// see the example below to see how to adhere to both Material spec and -/// accessibility requirements. -/// -/// Note that [leading] and [trailing] widgets can expand as far as they wish -/// horizontally, so ensure that they are properly constrained. -/// -/// List tiles are typically used in [ListView]s, or arranged in [Column]s in -/// [Drawer]s and [Card]s. -/// -/// One ancestor must be a [Material] widget and typically this is -/// provided by the app's [Scaffold]. The [tileColor], -/// [selectedTileColor], [focusColor], and [hoverColor] are not -/// painted by the list tile itself but by the material widget -/// ancestor. This generally has no effect. However, if an opaque -/// widget, like `Container(color: Colors.white)`, is included in -/// between the [ListTile] and its [Material] ancestor, then the -/// opaque widget will obscure the material widget and its background -/// [tileColor], etc. If this a problem, one can wrap a material -/// widget around the list tile, e.g.: -/// -/// ```dart -/// Container( -/// color: Colors.green, -/// child: Material( -/// child: ListTile( -/// title: const Text('ListTile with red background'), -/// tileColor: Colors.red, -/// ), -/// ), -/// ) -/// ``` -/// -/// {@tool snippet} -/// -/// This example uses a [ListView] to demonstrate different configurations of -/// [ListTile]s in [Card]s. -/// -/// ![Different variations of ListTile](https://flutter.github.io/assets-for-api-docs/assets/material/list_tile.png) -/// -/// ```dart -/// ListView( -/// children: const [ -/// Card(child: ListTile(title: Text('One-line ListTile'))), -/// Card( -/// child: ListTile( -/// leading: FlutterLogo(), -/// title: Text('One-line with leading widget'), -/// ), -/// ), -/// Card( -/// child: ListTile( -/// title: Text('One-line with trailing widget'), -/// trailing: Icon(Icons.more_vert), -/// ), -/// ), -/// Card( -/// child: ListTile( -/// leading: FlutterLogo(), -/// title: Text('One-line with both widgets'), -/// trailing: Icon(Icons.more_vert), -/// ), -/// ), -/// Card( -/// child: ListTile( -/// title: Text('One-line dense ListTile'), -/// dense: true, -/// ), -/// ), -/// Card( -/// child: ListTile( -/// leading: FlutterLogo(size: 56.0), -/// title: Text('Two-line ListTile'), -/// subtitle: Text('Here is a second line'), -/// trailing: Icon(Icons.more_vert), -/// ), -/// ), -/// Card( -/// child: ListTile( -/// leading: FlutterLogo(size: 72.0), -/// title: Text('Three-line ListTile'), -/// subtitle: Text( -/// 'A sufficiently long subtitle warrants three lines.' -/// ), -/// trailing: Icon(Icons.more_vert), -/// isThreeLine: true, -/// ), -/// ), -/// ], -/// ) -/// ``` -/// {@end-tool} -/// {@tool snippet} -/// -/// To use a [ListTile] within a [Row], it needs to be wrapped in an -/// [Expanded] widget. [ListTile] requires fixed width constraints, -/// whereas a [Row] does not constrain its children. -/// -/// ```dart -/// Row( -/// children: const [ -/// Expanded( -/// child: ListTile( -/// leading: FlutterLogo(), -/// title: Text('These ListTiles are expanded '), -/// ), -/// ), -/// Expanded( -/// child: ListTile( -/// trailing: FlutterLogo(), -/// title: Text('to fill the available space.'), -/// ), -/// ), -/// ], -/// ) -/// ``` -/// {@end-tool} -/// {@tool snippet} -/// -/// Tiles can be much more elaborate. Here is a tile which can be tapped, but -/// which is disabled when the `_act` variable is not 2. When the tile is -/// tapped, the whole row has an ink splash effect (see [InkWell]). -/// -/// ```dart -/// int _act = 1; -/// // ... -/// ListTile( -/// leading: const Icon(Icons.flight_land), -/// title: const Text("Trix's airplane"), -/// subtitle: _act != 2 ? const Text('The airplane is only in Act II.') : null, -/// enabled: _act == 2, -/// onTap: () { /* react to the tile being tapped */ } -/// ) -/// ``` -/// {@end-tool} -/// -/// To be accessible, tappable [leading] and [trailing] widgets have to -/// be at least 48x48 in size. However, to adhere to the Material spec, -/// [trailing] and [leading] widgets in one-line ListTiles should visually be -/// at most 32 ([dense]: true) or 40 ([dense]: false) in height, which may -/// conflict with the accessibility requirement. -/// -/// For this reason, a one-line ListTile allows the height of [leading] -/// and [trailing] widgets to be constrained by the height of the ListTile. -/// This allows for the creation of tappable [leading] and [trailing] widgets -/// that are large enough, but it is up to the developer to ensure that -/// their widgets follow the Material spec. -/// -/// {@tool snippet} -/// -/// Here is an example of a one-line, non-[dense] ListTile with a -/// tappable leading widget that adheres to accessibility requirements and -/// the Material spec. To adjust the use case below for a one-line, [dense] -/// ListTile, adjust the vertical padding to 8.0. -/// -/// ```dart -/// ListTile( -/// leading: GestureDetector( -/// behavior: HitTestBehavior.translucent, -/// onTap: () {}, -/// child: Container( -/// width: 48, -/// height: 48, -/// padding: const EdgeInsets.symmetric(vertical: 4.0), -/// alignment: Alignment.center, -/// child: const CircleAvatar(), -/// ), -/// ), -/// title: const Text('title'), -/// dense: false, -/// ) -/// ``` -/// {@end-tool} -/// -/// ## The ListTile layout isn't exactly what I want -/// -/// If the way ListTile pads and positions its elements isn't quite what -/// you're looking for, it's easy to create custom list items with a -/// combination of other widgets, such as [Row]s and [Column]s. -/// -/// {@tool dartpad --template=stateless_widget_scaffold} -/// -/// Here is an example of a custom list item that resembles a YouTube-related -/// video list item created with [Expanded] and [Container] widgets. -/// -/// ![Custom list item a](https://flutter.github.io/assets-for-api-docs/assets/widgets/custom_list_item_a.png) -/// -/// ```dart preamble -/// class CustomListItem extends StatelessWidget { -/// const CustomListItem({ -/// Key? key, -/// required this.thumbnail, -/// required this.title, -/// required this.user, -/// required this.viewCount, -/// }) : super(key: key); -/// -/// final Widget thumbnail; -/// final String title; -/// final String user; -/// final int viewCount; -/// -/// @override -/// Widget build(BuildContext context) { -/// return Padding( -/// padding: const EdgeInsets.symmetric(vertical: 5.0), -/// child: Row( -/// crossAxisAlignment: CrossAxisAlignment.start, -/// children: [ -/// Expanded( -/// flex: 2, -/// child: thumbnail, -/// ), -/// Expanded( -/// flex: 3, -/// child: _VideoDescription( -/// title: title, -/// user: user, -/// viewCount: viewCount, -/// ), -/// ), -/// const Icon( -/// Icons.more_vert, -/// size: 16.0, -/// ), -/// ], -/// ), -/// ); -/// } -/// } -/// -/// class _VideoDescription extends StatelessWidget { -/// const _VideoDescription({ -/// Key? key, -/// required this.title, -/// required this.user, -/// required this.viewCount, -/// }) : super(key: key); -/// -/// final String title; -/// final String user; -/// final int viewCount; -/// -/// @override -/// Widget build(BuildContext context) { -/// return Padding( -/// padding: const EdgeInsets.fromLTRB(5.0, 0.0, 0.0, 0.0), -/// child: Column( -/// crossAxisAlignment: CrossAxisAlignment.start, -/// children: [ -/// Text( -/// title, -/// style: const TextStyle( -/// fontWeight: FontWeight.w500, -/// fontSize: 14.0, -/// ), -/// ), -/// const Padding(padding: EdgeInsets.symmetric(vertical: 2.0)), -/// Text( -/// user, -/// style: const TextStyle(fontSize: 10.0), -/// ), -/// const Padding(padding: EdgeInsets.symmetric(vertical: 1.0)), -/// Text( -/// '$viewCount views', -/// style: const TextStyle(fontSize: 10.0), -/// ), -/// ], -/// ), -/// ); -/// } -/// } -/// ``` -/// -/// ```dart -/// Widget build(BuildContext context) { -/// return ListView( -/// padding: const EdgeInsets.all(8.0), -/// itemExtent: 106.0, -/// children: [ -/// CustomListItem( -/// user: 'Flutter', -/// viewCount: 999000, -/// thumbnail: Container( -/// decoration: const BoxDecoration(color: Colors.blue), -/// ), -/// title: 'The Flutter YouTube Channel', -/// ), -/// CustomListItem( -/// user: 'Dash', -/// viewCount: 884000, -/// thumbnail: Container( -/// decoration: const BoxDecoration(color: Colors.yellow), -/// ), -/// title: 'Announcing Flutter 1.0', -/// ), -/// ], -/// ); -/// } -/// ``` -/// {@end-tool} -/// -/// {@tool dartpad --template=stateless_widget_scaffold} -/// -/// Here is an example of an article list item with multiline titles and -/// subtitles. It utilizes [Row]s and [Column]s, as well as [Expanded] and -/// [AspectRatio] widgets to organize its layout. -/// -/// ![Custom list item b](https://flutter.github.io/assets-for-api-docs/assets/widgets/custom_list_item_b.png) -/// -/// ```dart preamble -/// class _ArticleDescription extends StatelessWidget { -/// const _ArticleDescription({ -/// Key? key, -/// required this.title, -/// required this.subtitle, -/// required this.author, -/// required this.publishDate, -/// required this.readDuration, -/// }) : super(key: key); -/// -/// final String title; -/// final String subtitle; -/// final String author; -/// final String publishDate; -/// final String readDuration; -/// -/// @override -/// Widget build(BuildContext context) { -/// return Column( -/// crossAxisAlignment: CrossAxisAlignment.start, -/// children: [ -/// Expanded( -/// flex: 1, -/// child: Column( -/// crossAxisAlignment: CrossAxisAlignment.start, -/// children: [ -/// Text( -/// title, -/// maxLines: 2, -/// overflow: TextOverflow.ellipsis, -/// style: const TextStyle( -/// fontWeight: FontWeight.bold, -/// ), -/// ), -/// const Padding(padding: EdgeInsets.only(bottom: 2.0)), -/// Text( -/// subtitle, -/// maxLines: 2, -/// overflow: TextOverflow.ellipsis, -/// style: const TextStyle( -/// fontSize: 12.0, -/// color: Colors.black54, -/// ), -/// ), -/// ], -/// ), -/// ), -/// Expanded( -/// flex: 1, -/// child: Column( -/// crossAxisAlignment: CrossAxisAlignment.start, -/// mainAxisAlignment: MainAxisAlignment.end, -/// children: [ -/// Text( -/// author, -/// style: const TextStyle( -/// fontSize: 12.0, -/// color: Colors.black87, -/// ), -/// ), -/// Text( -/// '$publishDate - $readDuration', -/// style: const TextStyle( -/// fontSize: 12.0, -/// color: Colors.black54, -/// ), -/// ), -/// ], -/// ), -/// ), -/// ], -/// ); -/// } -/// } -/// -/// class CustomListItemTwo extends StatelessWidget { -/// const CustomListItemTwo({ -/// Key? key, -/// required this.thumbnail, -/// required this.title, -/// required this.subtitle, -/// required this.author, -/// required this.publishDate, -/// required this.readDuration, -/// }) : super(key: key); -/// -/// final Widget thumbnail; -/// final String title; -/// final String subtitle; -/// final String author; -/// final String publishDate; -/// final String readDuration; -/// -/// @override -/// Widget build(BuildContext context) { -/// return Padding( -/// padding: const EdgeInsets.symmetric(vertical: 10.0), -/// child: SizedBox( -/// height: 100, -/// child: Row( -/// crossAxisAlignment: CrossAxisAlignment.start, -/// children: [ -/// AspectRatio( -/// aspectRatio: 1.0, -/// child: thumbnail, -/// ), -/// Expanded( -/// child: Padding( -/// padding: const EdgeInsets.fromLTRB(20.0, 0.0, 2.0, 0.0), -/// child: _ArticleDescription( -/// title: title, -/// subtitle: subtitle, -/// author: author, -/// publishDate: publishDate, -/// readDuration: readDuration, -/// ), -/// ), -/// ) -/// ], -/// ), -/// ), -/// ); -/// } -/// } -/// ``` -/// -/// ```dart -/// Widget build(BuildContext context) { -/// return ListView( -/// padding: const EdgeInsets.all(10.0), -/// children: [ -/// CustomListItemTwo( -/// thumbnail: Container( -/// decoration: const BoxDecoration(color: Colors.pink), -/// ), -/// title: 'Flutter 1.0 Launch', -/// subtitle: -/// 'Flutter continues to improve and expand its horizons. ' -/// 'This text should max out at two lines and clip', -/// author: 'Dash', -/// publishDate: 'Dec 28', -/// readDuration: '5 mins', -/// ), -/// CustomListItemTwo( -/// thumbnail: Container( -/// decoration: const BoxDecoration(color: Colors.blue), -/// ), -/// title: 'Flutter 1.2 Release - Continual updates to the framework', -/// subtitle: 'Flutter once again improves and makes updates.', -/// author: 'Flutter', -/// publishDate: 'Feb 26', -/// readDuration: '12 mins', -/// ), -/// ], -/// ); -/// } -/// ``` -/// {@end-tool} -/// -/// See also: -/// -/// * [ListTileMoreCustomizableTheme], which defines visual properties for [ListTileMoreCustomizable]s. -/// * [ListView], which can display an arbitrary number of [ListTileMoreCustomizable]s -/// in a scrolling list. -/// * [CircleAvatar], which shows an icon representing a person and is often -/// used as the [leading] element of a ListTile. -/// * [Card], which can be used with [Column] to show a few [ListTileMoreCustomizable]s. -/// * [Divider], which can be used to separate [ListTileMoreCustomizable]s. -/// * [ListTileMoreCustomizable.divideTiles], a utility for inserting [Divider]s in between [ListTileMoreCustomizable]s. -/// * [CheckboxListTile], [RadioListTile], and [SwitchListTile], widgets -/// that combine [ListTile] with other controls. -/// * -/// * Cookbook: [Use lists](https://flutter.dev/docs/cookbook/lists/basic-list) -/// * Cookbook: [Implement swipe to dismiss](https://flutter.dev/docs/cookbook/gestures/dismissible) class ListTileMoreCustomizable extends StatefulWidget { /// Creates a list tile. /// @@ -764,6 +26,10 @@ class ListTileMoreCustomizable extends StatefulWidget { this.dense, this.visualDensity, this.shape, + this.style, + this.selectedColor, + this.iconColor, + this.textColor, this.contentPadding, this.enabled = true, this.onTap, @@ -780,11 +46,7 @@ class ListTileMoreCustomizable extends StatefulWidget { this.horizontalTitleGap, this.minVerticalPadding, this.minLeadingWidth, - }) : assert(isThreeLine != null), - assert(enabled != null), - assert(selected != null), - assert(autofocus != null), - assert(!isThreeLine || subtitle != null), + }) : assert(!isThreeLine || subtitle != null), super(key: key); /// A widget to display before the title. @@ -816,8 +78,8 @@ class ListTileMoreCustomizable extends StatefulWidget { /// /// When [enabled] is false, the text color is set to [ThemeData.disabledColor]. /// - /// When [selected] is false, the text color is set to [ListTileMoreCustomizableTheme.textColor] - /// if it's not null and to [TextTheme.caption]'s color if [ListTileMoreCustomizableTheme.textColor] + /// When [selected] is false, the text color is set to [ListTileTheme.textColor] + /// if it's not null and to [TextTheme.caption]'s color if [ListTileTheme.textColor] /// is null. final Widget? subtitle; @@ -846,7 +108,7 @@ class ListTileMoreCustomizable extends StatefulWidget { /// Whether this list tile is part of a vertically dense list. /// - /// If this property is null then its value is based on [ListTileMoreCustomizableTheme.dense]. + /// If this property is null then its value is based on [ListTileTheme.dense]. /// /// Dense list tiles default to a smaller height. final bool? dense; @@ -865,13 +127,56 @@ class ListTileMoreCustomizable extends StatefulWidget { /// /// Defines the tile's [InkWell.customBorder] and [Ink.decoration] shape. /// - /// If this property is null then [ListTileMoreCustomizableTheme.shape] is used. + /// If this property is null then [ListTileTheme.shape] is used. /// If that's null then a rectangular [Border] will be used. final ShapeBorder? shape; + /// Defines the color used for icons and text when the list tile is selected. + /// + /// If this property is null then [ListTileThemeData.selectedColor] + /// is used. If that is also null then [ColorScheme.primary] is used. + /// + /// See also: + /// + /// * [ListTileTheme.of], which returns the nearest [ListTileTheme]'s + /// [ListTileThemeData]. + final Color? selectedColor; + + /// Defines the default color for [leading] and [trailing] icons. + /// + /// If this property is null then [ListTileThemeData.iconColor] is used. + /// + /// See also: + /// + /// * [ListTileTheme.of], which returns the nearest [ListTileTheme]'s + /// [ListTileThemeData]. + final Color? iconColor; + + /// Defines the default color for the [title] and [subtitle]. + /// + /// If this property is null then [ListTileThemeData.textColor] is used. If that + /// is also null then [ColorScheme.primary] is used. + /// + /// See also: + /// + /// * [ListTileTheme.of], which returns the nearest [ListTileTheme]'s + /// [ListTileThemeData]. + final Color? textColor; + + /// Defines the font used for the [title]. + /// + /// If this property is null then [ListTileThemeData.style] is used. If that + /// is also null then [ListTileStyle.list] is used. + /// + /// See also: + /// + /// * [ListTileTheme.of], which returns the nearest [ListTileTheme]'s + /// [ListTileThemeData]. + final ListTileStyle? style; + /// The tile's internal padding. /// - /// Insets a [ListTileMoreCustomizable]'s contents: its [leading], [title], [subtitle], + /// Insets a [ListTile]'s contents: its [leading], [title], [subtitle], /// and [trailing] widgets. /// /// If null, `EdgeInsets.symmetric(horizontal: 16.0)` is used. @@ -888,13 +193,13 @@ class ListTileMoreCustomizable extends StatefulWidget { /// The details information is recorded when InkWell's onTapDown occurred. /// /// Inoperative if [enabled] is false. - final GestureTapDownCallback? onTap; + final PointerDownEventListener? onTap; /// Called when the user long-presses on this list tile. /// The details information is recorded when InkWell's onTapDown occurred. /// /// Inoperative if [enabled] is false. - final GestureTapDownCallback? onLongPress; + final PointerDownEventListener? onLongPress; /// The cursor for a mouse pointer when it enters or is hovering over the /// widget. @@ -911,7 +216,7 @@ class ListTileMoreCustomizable extends StatefulWidget { /// If this tile is also [enabled] then icons and text are rendered with the same color. /// /// By default the selected color is the theme's primary color. The selected color - /// can be overridden with a [ListTileMoreCustomizableTheme]. + /// can be overridden with a [ListTileTheme]. /// /// {@tool dartpad --template=stateful_widget_scaffold} /// @@ -958,14 +263,14 @@ class ListTileMoreCustomizable extends StatefulWidget { /// {@template flutter.material.ListTile.tileColor} /// Defines the background color of `ListTile` when [selected] is false. /// - /// When the value is null, the `tileColor` is set to [ListTileMoreCustomizableTheme.tileColor] + /// When the value is null, the `tileColor` is set to [ListTileTheme.tileColor] /// if it's not null and to [Colors.transparent] if it's null. /// {@endtemplate} final Color? tileColor; /// Defines the background color of `ListTile` when [selected] is true. /// - /// When the value if null, the `selectedTileColor` is set to [ListTileMoreCustomizableTheme.selectedTileColor] + /// When the value if null, the `selectedTileColor` is set to [ListTileTheme.selectedTileColor] /// if it's not null and to [Colors.transparent] if it's null. final Color? selectedTileColor; @@ -981,971 +286,79 @@ class ListTileMoreCustomizable extends StatefulWidget { /// The horizontal gap between the titles and the leading/trailing widgets. /// - /// If null, then the value of [ListTileMoreCustomizableTheme.horizontalTitleGap] is used. If + /// If null, then the value of [ListTileTheme.horizontalTitleGap] is used. If /// that is also null, then a default value of 16 is used. final double? horizontalTitleGap; /// The minimum padding on the top and bottom of the title and subtitle widgets. /// - /// If null, then the value of [ListTileMoreCustomizableTheme.minVerticalPadding] is used. If + /// If null, then the value of [ListTileTheme.minVerticalPadding] is used. If /// that is also null, then a default value of 4 is used. final double? minVerticalPadding; - /// The minimum width allocated for the [ListTileMoreCustomizable.leading] widget. + /// The minimum width allocated for the [ListTile.leading] widget. /// - /// If null, then the value of [ListTileMoreCustomizableTheme.minLeadingWidth] is used. If + /// If null, then the value of [ListTileTheme.minLeadingWidth] is used. If /// that is also null, then a default value of 40 is used. final double? minLeadingWidth; - /// Add a one pixel border in between each tile. If color isn't specified the - /// [ThemeData.dividerColor] of the context's [Theme] is used. - /// - /// See also: - /// - /// * [Divider], which you can use to obtain this effect manually. - static Iterable divideTiles( - {BuildContext? context, - required Iterable tiles, - Color? color}) sync* { - assert(tiles != null); - assert(color != null || context != null); - - final Iterator iterator = tiles.iterator; - final bool hasNext = iterator.moveNext(); - - if (!hasNext) return; - - final Decoration decoration = BoxDecoration( - border: Border( - bottom: Divider.createBorderSide(context, color: color), - ), - ); - - Widget tile = iterator.current; - while (iterator.moveNext()) { - yield DecoratedBox( - position: DecorationPosition.foreground, - decoration: decoration, - child: tile, - ); - tile = iterator.current; - } - if (hasNext) yield tile; - } - @override - _ListTileMoreCustomizableState createState() => + State createState() => _ListTileMoreCustomizableState(); } class _ListTileMoreCustomizableState extends State { - late TapDownDetails tapDownDetails; - - Color? _iconColor(ThemeData theme, ListTileMoreCustomizableTheme? tileTheme) { - if (!widget.enabled) return theme.disabledColor; - - if (widget.selected && tileTheme?.selectedColor != null) - return tileTheme!.selectedColor; - - if (!widget.selected && tileTheme?.iconColor != null) - return tileTheme!.iconColor; - - switch (theme.brightness) { - case Brightness.light: - // For the sake of backwards compatibility, the default for unselected - // tiles is Colors.black45 rather than colorScheme.onSurface.withAlpha(0x73). - return widget.selected ? theme.colorScheme.primary : Colors.black45; - case Brightness.dark: - return widget.selected - ? theme.colorScheme.primary - : null; // null - use current icon theme color - } - } - - Color? _textColor(ThemeData theme, ListTileMoreCustomizableTheme? tileTheme, - Color? defaultColor) { - if (!widget.enabled) return theme.disabledColor; - - if (widget.selected && tileTheme?.selectedColor != null) - return tileTheme!.selectedColor; - - if (!widget.selected && tileTheme?.textColor != null) - return tileTheme!.textColor; + PointerDownEvent? pointerDownDetails; - if (widget.selected) return theme.colorScheme.primary; - - return defaultColor; - } - - bool _isDenseLayout(ListTileMoreCustomizableTheme? tileTheme) { - return widget.dense ?? tileTheme?.dense ?? false; - } - - TextStyle _titleTextStyle( - ThemeData theme, ListTileMoreCustomizableTheme? tileTheme) { - final TextStyle style; - if (tileTheme != null) { - switch (tileTheme.style) { - case ListTileMoreCustomizableStyle.drawer: - style = theme.textTheme.bodyText1!; - break; - case ListTileMoreCustomizableStyle.list: - style = theme.textTheme.subtitle1!; - break; - } - } else { - style = theme.textTheme.subtitle1!; - } - final Color? color = _textColor(theme, tileTheme, style.color); - return _isDenseLayout(tileTheme) - ? style.copyWith(fontSize: 13.0, color: color) - : style.copyWith(color: color); - } - - TextStyle _subtitleTextStyle( - ThemeData theme, ListTileMoreCustomizableTheme? tileTheme) { - final TextStyle style = theme.textTheme.bodyText2!; - final Color? color = - _textColor(theme, tileTheme, theme.textTheme.caption!.color); - return _isDenseLayout(tileTheme) - ? style.copyWith(color: color, fontSize: 12.0) - : style.copyWith(color: color); + toOnTap() { + if (pointerDownDetails != null) widget.onTap!(pointerDownDetails!); } - TextStyle _trailingAndLeadingTextStyle( - ThemeData theme, ListTileMoreCustomizableTheme? tileTheme) { - final TextStyle style = theme.textTheme.bodyText2!; - final Color? color = _textColor(theme, tileTheme, style.color); - return style.copyWith(color: color); + toOnLongPress() { + if (pointerDownDetails != null) widget.onLongPress!(pointerDownDetails!); } - Color _tileBackgroundColor(ListTileMoreCustomizableTheme? tileTheme) { - if (!widget.selected) { - if (widget.tileColor != null) return widget.tileColor!; - if (tileTheme?.tileColor != null) return tileTheme!.tileColor!; - } - - if (widget.selected) { - if (widget.selectedTileColor != null) return widget.selectedTileColor!; - if (tileTheme?.selectedTileColor != null) - return tileTheme!.selectedTileColor!; - } - - return Colors.transparent; + // Records PointerDownEvent when the onTapDown event fired. + recordPointerDownEvent(PointerDownEvent details) { + pointerDownDetails = details; } @override Widget build(BuildContext context) { - assert(debugCheckHasMaterial(context)); - final ThemeData theme = Theme.of(context); - final ListTileMoreCustomizableTheme tileTheme = - ListTileMoreCustomizableTheme.of(context); - - IconThemeData? iconThemeData; - TextStyle? leadingAndTrailingTextStyle; - if (widget.leading != null || widget.trailing != null) { - iconThemeData = IconThemeData(color: _iconColor(theme, tileTheme)); - leadingAndTrailingTextStyle = - _trailingAndLeadingTextStyle(theme, tileTheme); - } - - Widget? leadingIcon; - if (widget.leading != null) { - leadingIcon = AnimatedDefaultTextStyle( - style: leadingAndTrailingTextStyle!, - duration: kThemeChangeDuration, - child: IconTheme.merge( - data: iconThemeData!, - child: widget.leading!, - ), - ); - } - - final TextStyle titleStyle = _titleTextStyle(theme, tileTheme); - final Widget titleText = AnimatedDefaultTextStyle( - style: titleStyle, - duration: kThemeChangeDuration, - child: widget.title ?? const SizedBox(), - ); - - Widget? subtitleText; - TextStyle? subtitleStyle; - if (widget.subtitle != null) { - subtitleStyle = _subtitleTextStyle(theme, tileTheme); - subtitleText = AnimatedDefaultTextStyle( - style: subtitleStyle, - duration: kThemeChangeDuration, - child: widget.subtitle!, - ); - } - - Widget? trailingIcon; - if (widget.trailing != null) { - trailingIcon = AnimatedDefaultTextStyle( - style: leadingAndTrailingTextStyle!, - duration: kThemeChangeDuration, - child: IconTheme.merge( - data: iconThemeData!, - child: widget.trailing!, - ), - ); - } - - const EdgeInsets _defaultContentPadding = - EdgeInsets.symmetric(horizontal: 16.0); - final TextDirection textDirection = Directionality.of(context); - final EdgeInsets resolvedContentPadding = - widget.contentPadding?.resolve(textDirection) ?? - tileTheme.contentPadding?.resolve(textDirection) ?? - _defaultContentPadding; - - final MouseCursor resolvedMouseCursor = - MaterialStateProperty.resolveAs( - widget.mouseCursor ?? MaterialStateMouseCursor.clickable, - { - if (!widget.enabled || - (widget.onTap == null && widget.onLongPress == null)) - MaterialState.disabled, - if (widget.selected) MaterialState.selected, - }, - ); - - return InkWell( - customBorder: widget.shape ?? tileTheme.shape, - onTap: widget.enabled && widget.onTap != null ? toOnTap : null, - onLongPress: - widget.enabled && widget.onLongPress != null ? toOnLongPress : null, - mouseCursor: resolvedMouseCursor, - onTapDown: widget.enabled ? recordTapDownDetails : null, - canRequestFocus: widget.enabled, - focusNode: widget.focusNode, - focusColor: widget.focusColor, - hoverColor: widget.hoverColor, - autofocus: widget.autofocus, - enableFeedback: widget.enableFeedback ?? tileTheme.enableFeedback ?? true, - child: Semantics( - selected: widget.selected, + return Listener( + behavior: HitTestBehavior.translucent, + onPointerDown: widget.enabled ? recordPointerDownEvent : null, + child: ListTile( + leading: widget.leading, + title: widget.title, + subtitle: widget.subtitle, + trailing: widget.trailing, + isThreeLine: widget.isThreeLine, + dense: widget.dense, + visualDensity: widget.visualDensity, + shape: widget.shape, + style: widget.style, + selectedColor: widget.selectedColor, + iconColor: widget.iconColor, + textColor: widget.textColor, + contentPadding: widget.contentPadding, enabled: widget.enabled, - child: Ink( - decoration: ShapeDecoration( - shape: widget.shape ?? tileTheme.shape ?? const Border(), - color: _tileBackgroundColor(tileTheme), - ), - child: SafeArea( - top: false, - bottom: false, - minimum: resolvedContentPadding, - child: _ListTileMoreCustomizable( - leading: leadingIcon, - title: titleText, - subtitle: subtitleText, - trailing: trailingIcon, - isDense: _isDenseLayout(tileTheme), - visualDensity: widget.visualDensity ?? theme.visualDensity, - isThreeLine: widget.isThreeLine, - textDirection: textDirection, - titleBaselineType: titleStyle.textBaseline!, - subtitleBaselineType: subtitleStyle?.textBaseline, - horizontalTitleGap: widget.horizontalTitleGap ?? - tileTheme.horizontalTitleGap ?? - 16, - minVerticalPadding: widget.minVerticalPadding ?? - tileTheme.minVerticalPadding ?? - 4, - minLeadingWidth: - widget.minLeadingWidth ?? tileTheme.minLeadingWidth ?? 40, - ), - ), - ), + onTap: widget.enabled && widget.onTap != null ? toOnTap : null, + onLongPress: + widget.enabled && widget.onLongPress != null ? toOnLongPress : null, + mouseCursor: widget.mouseCursor, + selected: widget.selected, + focusColor: widget.focusColor, + hoverColor: widget.hoverColor, + focusNode: widget.focusNode, + autofocus: widget.autofocus, + tileColor: widget.tileColor, + selectedTileColor: widget.selectedTileColor, + enableFeedback: widget.enableFeedback, + horizontalTitleGap: widget.horizontalTitleGap, + minVerticalPadding: widget.minVerticalPadding, + minLeadingWidth: widget.minLeadingWidth, ), ); } - - toOnTap() { - widget.onTap!(tapDownDetails); - } - - toOnLongPress() { - widget.onLongPress!(tapDownDetails); - } - - // Records TapDownDetails when the onTapDown event fired. - recordTapDownDetails(TapDownDetails d) { - tapDownDetails = d; - } -} - -// Identifies the children of a _ListTileElement. -enum _ListTileMoreCustomizableSlot { - leading, - title, - subtitle, - trailing, -} - -class _ListTileMoreCustomizable extends RenderObjectWidget { - const _ListTileMoreCustomizable({ - Key? key, - this.leading, - required this.title, - this.subtitle, - this.trailing, - required this.isThreeLine, - required this.isDense, - required this.visualDensity, - required this.textDirection, - required this.titleBaselineType, - required this.horizontalTitleGap, - required this.minVerticalPadding, - required this.minLeadingWidth, - this.subtitleBaselineType, - }) : assert(isThreeLine != null), - assert(isDense != null), - assert(visualDensity != null), - assert(textDirection != null), - assert(titleBaselineType != null), - assert(horizontalTitleGap != null), - assert(minVerticalPadding != null), - assert(minLeadingWidth != null), - super(key: key); - - final Widget? leading; - final Widget title; - final Widget? subtitle; - final Widget? trailing; - final bool isThreeLine; - final bool isDense; - final VisualDensity visualDensity; - final TextDirection textDirection; - final TextBaseline titleBaselineType; - final TextBaseline? subtitleBaselineType; - final double horizontalTitleGap; - final double minVerticalPadding; - final double minLeadingWidth; - - @override - _ListTileMoreCustomizableElement createElement() => - _ListTileMoreCustomizableElement(this); - - @override - _RenderListTileMoreCustomizable createRenderObject(BuildContext context) { - return _RenderListTileMoreCustomizable( - isThreeLine: isThreeLine, - isDense: isDense, - visualDensity: visualDensity, - textDirection: textDirection, - titleBaselineType: titleBaselineType, - subtitleBaselineType: subtitleBaselineType, - horizontalTitleGap: horizontalTitleGap, - minVerticalPadding: minVerticalPadding, - minLeadingWidth: minLeadingWidth, - ); - } - - @override - void updateRenderObject( - BuildContext context, _RenderListTileMoreCustomizable renderObject) { - renderObject - ..isThreeLine = isThreeLine - ..isDense = isDense - ..visualDensity = visualDensity - ..textDirection = textDirection - ..titleBaselineType = titleBaselineType - ..subtitleBaselineType = subtitleBaselineType - ..horizontalTitleGap = horizontalTitleGap - ..minLeadingWidth = minLeadingWidth - ..minVerticalPadding = minVerticalPadding; - } -} - -class _ListTileMoreCustomizableElement extends RenderObjectElement { - _ListTileMoreCustomizableElement(_ListTileMoreCustomizable widget) - : super(widget); - - final Map<_ListTileMoreCustomizableSlot, Element> slotToChild = - <_ListTileMoreCustomizableSlot, Element>{}; - - @override - _ListTileMoreCustomizable get widget => - super.widget as _ListTileMoreCustomizable; - - @override - _RenderListTileMoreCustomizable get renderObject => - super.renderObject as _RenderListTileMoreCustomizable; - - @override - void visitChildren(ElementVisitor visitor) { - slotToChild.values.forEach(visitor); - } - - @override - void forgetChild(Element child) { - assert(slotToChild.containsValue(child)); - assert(child.slot is _ListTileMoreCustomizableSlot); - assert(slotToChild.containsKey(child.slot)); - slotToChild.remove(child.slot); - super.forgetChild(child); - } - - void _mountChild(Widget? widget, _ListTileMoreCustomizableSlot slot) { - final Element? oldChild = slotToChild[slot]; - final Element? newChild = updateChild(oldChild, widget, slot); - if (oldChild != null) { - slotToChild.remove(slot); - } - if (newChild != null) { - slotToChild[slot] = newChild; - } - } - - @override - void mount(Element? parent, Object? newSlot) { - super.mount(parent, newSlot); - _mountChild(widget.leading, _ListTileMoreCustomizableSlot.leading); - _mountChild(widget.title, _ListTileMoreCustomizableSlot.title); - _mountChild(widget.subtitle, _ListTileMoreCustomizableSlot.subtitle); - _mountChild(widget.trailing, _ListTileMoreCustomizableSlot.trailing); - } - - void _updateChild(Widget? widget, _ListTileMoreCustomizableSlot slot) { - final Element? oldChild = slotToChild[slot]; - final Element? newChild = updateChild(oldChild, widget, slot); - if (oldChild != null) { - slotToChild.remove(slot); - } - if (newChild != null) { - slotToChild[slot] = newChild; - } - } - - @override - void update(_ListTileMoreCustomizable newWidget) { - super.update(newWidget); - assert(widget == newWidget); - _updateChild(widget.leading, _ListTileMoreCustomizableSlot.leading); - _updateChild(widget.title, _ListTileMoreCustomizableSlot.title); - _updateChild(widget.subtitle, _ListTileMoreCustomizableSlot.subtitle); - _updateChild(widget.trailing, _ListTileMoreCustomizableSlot.trailing); - } - - void _updateRenderObject( - RenderBox? child, _ListTileMoreCustomizableSlot slot) { - switch (slot) { - case _ListTileMoreCustomizableSlot.leading: - renderObject.leading = child; - break; - case _ListTileMoreCustomizableSlot.title: - renderObject.title = child; - break; - case _ListTileMoreCustomizableSlot.subtitle: - renderObject.subtitle = child; - break; - case _ListTileMoreCustomizableSlot.trailing: - renderObject.trailing = child; - break; - } - } - - @override - void insertRenderObjectChild( - RenderObject child, _ListTileMoreCustomizableSlot slot) { - assert(child is RenderBox); - _updateRenderObject(child as RenderBox, slot); - assert(renderObject.children.keys.contains(slot)); - } - - @override - void removeRenderObjectChild( - RenderObject child, _ListTileMoreCustomizableSlot slot) { - assert(child is RenderBox); - assert(renderObject.children[slot] == child); - _updateRenderObject(null, slot); - assert(!renderObject.children.keys.contains(slot)); - } - - @override - void moveRenderObjectChild( - RenderObject child, Object? oldSlot, Object? newSlot) { - assert(false, 'not reachable'); - } -} - -class _RenderListTileMoreCustomizable extends RenderBox { - _RenderListTileMoreCustomizable({ - required bool isDense, - required VisualDensity visualDensity, - required bool isThreeLine, - required TextDirection textDirection, - required TextBaseline titleBaselineType, - TextBaseline? subtitleBaselineType, - required double horizontalTitleGap, - required double minVerticalPadding, - required double minLeadingWidth, - }) : assert(isDense != null), - assert(visualDensity != null), - assert(isThreeLine != null), - assert(textDirection != null), - assert(titleBaselineType != null), - assert(horizontalTitleGap != null), - assert(minVerticalPadding != null), - assert(minLeadingWidth != null), - _isDense = isDense, - _visualDensity = visualDensity, - _isThreeLine = isThreeLine, - _textDirection = textDirection, - _titleBaselineType = titleBaselineType, - _subtitleBaselineType = subtitleBaselineType, - _horizontalTitleGap = horizontalTitleGap, - _minVerticalPadding = minVerticalPadding, - _minLeadingWidth = minLeadingWidth; - - final Map<_ListTileMoreCustomizableSlot, RenderBox> children = - <_ListTileMoreCustomizableSlot, RenderBox>{}; - - RenderBox? _updateChild(RenderBox? oldChild, RenderBox? newChild, - _ListTileMoreCustomizableSlot slot) { - if (oldChild != null) { - dropChild(oldChild); - children.remove(slot); - } - if (newChild != null) { - children[slot] = newChild; - adoptChild(newChild); - } - return newChild; - } - - RenderBox? _leading; - RenderBox? get leading => _leading; - set leading(RenderBox? value) { - _leading = - _updateChild(_leading, value, _ListTileMoreCustomizableSlot.leading); - } - - RenderBox? _title; - RenderBox? get title => _title; - set title(RenderBox? value) { - _title = _updateChild(_title, value, _ListTileMoreCustomizableSlot.title); - } - - RenderBox? _subtitle; - RenderBox? get subtitle => _subtitle; - set subtitle(RenderBox? value) { - _subtitle = - _updateChild(_subtitle, value, _ListTileMoreCustomizableSlot.subtitle); - } - - RenderBox? _trailing; - RenderBox? get trailing => _trailing; - set trailing(RenderBox? value) { - _trailing = - _updateChild(_trailing, value, _ListTileMoreCustomizableSlot.trailing); - } - - // The returned list is ordered for hit testing. - Iterable get _children sync* { - if (leading != null) yield leading!; - if (title != null) yield title!; - if (subtitle != null) yield subtitle!; - if (trailing != null) yield trailing!; - } - - bool get isDense => _isDense; - bool _isDense; - set isDense(bool value) { - assert(value != null); - if (_isDense == value) return; - _isDense = value; - markNeedsLayout(); - } - - VisualDensity get visualDensity => _visualDensity; - VisualDensity _visualDensity; - set visualDensity(VisualDensity value) { - assert(value != null); - if (_visualDensity == value) return; - _visualDensity = value; - markNeedsLayout(); - } - - bool get isThreeLine => _isThreeLine; - bool _isThreeLine; - set isThreeLine(bool value) { - assert(value != null); - if (_isThreeLine == value) return; - _isThreeLine = value; - markNeedsLayout(); - } - - TextDirection get textDirection => _textDirection; - TextDirection _textDirection; - set textDirection(TextDirection value) { - assert(value != null); - if (_textDirection == value) return; - _textDirection = value; - markNeedsLayout(); - } - - TextBaseline get titleBaselineType => _titleBaselineType; - TextBaseline _titleBaselineType; - set titleBaselineType(TextBaseline value) { - assert(value != null); - if (_titleBaselineType == value) return; - _titleBaselineType = value; - markNeedsLayout(); - } - - TextBaseline? get subtitleBaselineType => _subtitleBaselineType; - TextBaseline? _subtitleBaselineType; - set subtitleBaselineType(TextBaseline? value) { - if (_subtitleBaselineType == value) return; - _subtitleBaselineType = value; - markNeedsLayout(); - } - - double get horizontalTitleGap => _horizontalTitleGap; - double _horizontalTitleGap; - double get _effectiveHorizontalTitleGap => - _horizontalTitleGap + visualDensity.horizontal * 2.0; - - set horizontalTitleGap(double value) { - assert(value != null); - if (_horizontalTitleGap == value) return; - _horizontalTitleGap = value; - markNeedsLayout(); - } - - double get minVerticalPadding => _minVerticalPadding; - double _minVerticalPadding; - - set minVerticalPadding(double value) { - assert(value != null); - if (_minVerticalPadding == value) return; - _minVerticalPadding = value; - markNeedsLayout(); - } - - double get minLeadingWidth => _minLeadingWidth; - double _minLeadingWidth; - - set minLeadingWidth(double value) { - assert(value != null); - if (_minLeadingWidth == value) return; - _minLeadingWidth = value; - markNeedsLayout(); - } - - @override - void attach(PipelineOwner owner) { - super.attach(owner); - for (final RenderBox child in _children) child.attach(owner); - } - - @override - void detach() { - super.detach(); - for (final RenderBox child in _children) child.detach(); - } - - @override - void redepthChildren() { - _children.forEach(redepthChild); - } - - @override - void visitChildren(RenderObjectVisitor visitor) { - _children.forEach(visitor); - } - - @override - List debugDescribeChildren() { - final List value = []; - void add(RenderBox? child, String name) { - if (child != null) value.add(child.toDiagnosticsNode(name: name)); - } - - add(leading, 'leading'); - add(title, 'title'); - add(subtitle, 'subtitle'); - add(trailing, 'trailing'); - return value; - } - - @override - bool get sizedByParent => false; - - static double _minWidth(RenderBox? box, double height) { - return box == null ? 0.0 : box.getMinIntrinsicWidth(height); - } - - static double _maxWidth(RenderBox? box, double height) { - return box == null ? 0.0 : box.getMaxIntrinsicWidth(height); - } - - @override - double computeMinIntrinsicWidth(double height) { - final double leadingWidth = leading != null - ? math.max(leading!.getMinIntrinsicWidth(height), _minLeadingWidth) + - _effectiveHorizontalTitleGap - : 0.0; - return leadingWidth + - math.max(_minWidth(title, height), _minWidth(subtitle, height)) + - _maxWidth(trailing, height); - } - - @override - double computeMaxIntrinsicWidth(double height) { - final double leadingWidth = leading != null - ? math.max(leading!.getMaxIntrinsicWidth(height), _minLeadingWidth) + - _effectiveHorizontalTitleGap - : 0.0; - return leadingWidth + - math.max(_maxWidth(title, height), _maxWidth(subtitle, height)) + - _maxWidth(trailing, height); - } - - double get _defaultTileHeight { - final bool hasSubtitle = subtitle != null; - final bool isTwoLine = !isThreeLine && hasSubtitle; - final bool isOneLine = !isThreeLine && !hasSubtitle; - - final Offset baseDensity = visualDensity.baseSizeAdjustment; - if (isOneLine) return (isDense ? 48.0 : 56.0) + baseDensity.dy; - if (isTwoLine) return (isDense ? 64.0 : 72.0) + baseDensity.dy; - return (isDense ? 76.0 : 88.0) + baseDensity.dy; - } - - @override - double computeMinIntrinsicHeight(double width) { - return math.max( - _defaultTileHeight, - title!.getMinIntrinsicHeight(width) + - (subtitle?.getMinIntrinsicHeight(width) ?? 0.0), - ); - } - - @override - double computeMaxIntrinsicHeight(double width) { - return computeMinIntrinsicHeight(width); - } - - @override - double computeDistanceToActualBaseline(TextBaseline baseline) { - assert(title != null); - final BoxParentData parentData = title!.parentData! as BoxParentData; - return parentData.offset.dy + title!.getDistanceToActualBaseline(baseline)!; - } - - static double? _boxBaseline(RenderBox box, TextBaseline baseline) { - return box.getDistanceToBaseline(baseline); - } - - static Size _layoutBox(RenderBox? box, BoxConstraints constraints) { - if (box == null) return Size.zero; - box.layout(constraints, parentUsesSize: true); - return box.size; - } - - static void _positionBox(RenderBox box, Offset offset) { - final BoxParentData parentData = box.parentData! as BoxParentData; - parentData.offset = offset; - } - - @override - Size computeDryLayout(BoxConstraints constraints) { - assert(debugCannotComputeDryLayout( - reason: - 'Layout requires baseline metrics, which are only available after a full layout.', - )); - return Size.zero; - } - - // All of the dimensions below were taken from the Material Design spec: - // https://material.io/design/components/lists.html#specs - @override - void performLayout() { - final BoxConstraints constraints = this.constraints; - final bool hasLeading = leading != null; - final bool hasSubtitle = subtitle != null; - final bool hasTrailing = trailing != null; - final bool isTwoLine = !isThreeLine && hasSubtitle; - final bool isOneLine = !isThreeLine && !hasSubtitle; - final Offset densityAdjustment = visualDensity.baseSizeAdjustment; - - final BoxConstraints maxIconHeightConstraint = BoxConstraints( - // One-line trailing and leading widget heights do not follow - // Material specifications, but this sizing is required to adhere - // to accessibility requirements for smallest tappable widget. - // Two- and three-line trailing widget heights are constrained - // properly according to the Material spec. - maxHeight: (isDense ? 48.0 : 56.0) + densityAdjustment.dy, - ); - final BoxConstraints looseConstraints = constraints.loosen(); - final BoxConstraints iconConstraints = - looseConstraints.enforce(maxIconHeightConstraint); - - final double tileWidth = looseConstraints.maxWidth; - final Size leadingSize = _layoutBox(leading, iconConstraints); - final Size trailingSize = _layoutBox(trailing, iconConstraints); - assert( - tileWidth != leadingSize.width || tileWidth == 0.0, - 'Leading widget consumes entire tile width. Please use a sized widget, ' - 'or consider replacing ListTile with a custom widget ' - '(see https://api.flutter.dev/flutter/material/ListTile-class.html#material.ListTile.4)', - ); - assert( - tileWidth != trailingSize.width || tileWidth == 0.0, - 'Trailing widget consumes entire tile width. Please use a sized widget, ' - 'or consider replacing ListTile with a custom widget ' - '(see https://api.flutter.dev/flutter/material/ListTile-class.html#material.ListTile.4)', - ); - - final double titleStart = hasLeading - ? math.max(_minLeadingWidth, leadingSize.width) + - _effectiveHorizontalTitleGap - : 0.0; - final double adjustedTrailingWidth = hasTrailing - ? math.max(trailingSize.width + _effectiveHorizontalTitleGap, 32.0) - : 0.0; - final BoxConstraints textConstraints = looseConstraints.tighten( - width: tileWidth - titleStart - adjustedTrailingWidth, - ); - final Size titleSize = _layoutBox(title, textConstraints); - final Size subtitleSize = _layoutBox(subtitle, textConstraints); - - double? titleBaseline; - double? subtitleBaseline; - if (isTwoLine) { - titleBaseline = isDense ? 28.0 : 32.0; - subtitleBaseline = isDense ? 48.0 : 52.0; - } else if (isThreeLine) { - titleBaseline = isDense ? 22.0 : 28.0; - subtitleBaseline = isDense ? 42.0 : 48.0; - } else { - assert(isOneLine); - } - - final double defaultTileHeight = _defaultTileHeight; - - double tileHeight; - double titleY; - double? subtitleY; - if (!hasSubtitle) { - tileHeight = math.max( - defaultTileHeight, titleSize.height + 2.0 * _minVerticalPadding); - titleY = (tileHeight - titleSize.height) / 2.0; - } else { - assert(subtitleBaselineType != null); - titleY = titleBaseline! - _boxBaseline(title!, titleBaselineType)!; - subtitleY = subtitleBaseline! - - _boxBaseline(subtitle!, subtitleBaselineType!)! + - visualDensity.vertical * 2.0; - tileHeight = defaultTileHeight; - - // If the title and subtitle overlap, move the title upwards by half - // the overlap and the subtitle down by the same amount, and adjust - // tileHeight so that both titles fit. - final double titleOverlap = titleY + titleSize.height - subtitleY; - if (titleOverlap > 0.0) { - titleY -= titleOverlap / 2.0; - subtitleY += titleOverlap / 2.0; - } - - // If the title or subtitle overflow tileHeight then punt: title - // and subtitle are arranged in a column, tileHeight = column height plus - // _minVerticalPadding on top and bottom. - if (titleY < _minVerticalPadding || - (subtitleY + subtitleSize.height + _minVerticalPadding) > - tileHeight) { - tileHeight = - titleSize.height + subtitleSize.height + 2.0 * _minVerticalPadding; - titleY = _minVerticalPadding; - subtitleY = titleSize.height + _minVerticalPadding; - } - } - - // This attempts to implement the redlines for the vertical position of the - // leading and trailing icons on the spec page: - // https://material.io/design/components/lists.html#specs - // The interpretation for these redlines is as follows: - // - For large tiles (> 72dp), both leading and trailing controls should be - // a fixed distance from top. As per guidelines this is set to 16dp. - // - For smaller tiles, trailing should always be centered. Leading can be - // centered or closer to the top. It should never be further than 16dp - // to the top. - final double leadingY; - final double trailingY; - if (tileHeight > 72.0) { - leadingY = 16.0; - trailingY = 16.0; - } else { - leadingY = math.min((tileHeight - leadingSize.height) / 2.0, 16.0); - trailingY = (tileHeight - trailingSize.height) / 2.0; - } - - switch (textDirection) { - case TextDirection.rtl: - { - if (hasLeading) - _positionBox( - leading!, Offset(tileWidth - leadingSize.width, leadingY)); - _positionBox(title!, Offset(adjustedTrailingWidth, titleY)); - if (hasSubtitle) - _positionBox(subtitle!, Offset(adjustedTrailingWidth, subtitleY!)); - if (hasTrailing) _positionBox(trailing!, Offset(0.0, trailingY)); - break; - } - case TextDirection.ltr: - { - if (hasLeading) _positionBox(leading!, Offset(0.0, leadingY)); - _positionBox(title!, Offset(titleStart, titleY)); - if (hasSubtitle) - _positionBox(subtitle!, Offset(titleStart, subtitleY!)); - if (hasTrailing) - _positionBox( - trailing!, Offset(tileWidth - trailingSize.width, trailingY)); - break; - } - } - - size = constraints.constrain(Size(tileWidth, tileHeight)); - assert(size.width == constraints.constrainWidth(tileWidth)); - assert(size.height == constraints.constrainHeight(tileHeight)); - } - - @override - void paint(PaintingContext context, Offset offset) { - void doPaint(RenderBox? child) { - if (child != null) { - final BoxParentData parentData = child.parentData! as BoxParentData; - context.paintChild(child, parentData.offset + offset); - } - } - - doPaint(leading); - doPaint(title); - doPaint(subtitle); - doPaint(trailing); - } - - @override - bool hitTestSelf(Offset position) => true; - - @override - bool hitTestChildren(BoxHitTestResult result, {required Offset position}) { - assert(position != null); - for (final RenderBox child in _children) { - final BoxParentData parentData = child.parentData! as BoxParentData; - final bool isHit = result.addWithPaintOffset( - offset: parentData.offset, - position: position, - hitTest: (BoxHitTestResult result, Offset transformed) { - assert(transformed == position - parentData.offset); - return child.hitTest(result, position: transformed); - }, - ); - if (isHit) return true; - } - return false; - } } diff --git a/pubspec.lock b/pubspec.lock index 6dfea46..3240896 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -5,49 +5,49 @@ packages: dependency: transitive description: name: async - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "2.8.1" + version: "2.8.2" boolean_selector: dependency: transitive description: name: boolean_selector - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "2.1.0" characters: dependency: transitive description: name: characters - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "1.1.0" + version: "1.2.0" charcode: dependency: transitive description: name: charcode - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.3.1" clock: dependency: transitive description: name: clock - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.1.0" collection: dependency: transitive description: name: collection - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.15.0" fake_async: dependency: transitive description: name: fake_async - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.2.0" flutter: @@ -64,23 +64,30 @@ packages: dependency: transitive description: name: matcher - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" + source: hosted + version: "0.12.11" + material_color_utilities: + dependency: transitive + description: + name: material_color_utilities + url: "https://pub.dartlang.org" source: hosted - version: "0.12.10" + version: "0.1.4" meta: dependency: transitive description: name: meta - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.7.0" path: dependency: transitive description: name: path - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "1.8.0" + version: "1.8.1" sky_engine: dependency: transitive description: flutter @@ -90,57 +97,57 @@ packages: dependency: transitive description: name: source_span - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "1.8.1" + version: "1.8.2" stack_trace: dependency: transitive description: name: stack_trace - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.10.0" stream_channel: dependency: transitive description: name: stream_channel - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "2.1.0" string_scanner: dependency: transitive description: name: string_scanner - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.1.0" term_glyph: dependency: transitive description: name: term_glyph - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.2.0" test_api: dependency: transitive description: name: test_api - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "0.4.2" + version: "0.4.9" typed_data: dependency: transitive description: name: typed_data - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted version: "1.3.0" vector_math: dependency: transitive description: name: vector_math - url: "https://pub.flutter-io.cn" + url: "https://pub.dartlang.org" source: hosted - version: "2.1.0" + version: "2.1.2" sdks: - dart: ">=2.12.0 <3.0.0" + dart: ">=2.14.0 <3.0.0" diff --git a/pubspec.yaml b/pubspec.yaml index 7213335..d8c0057 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: list_tile_more_customizable description: A ListTile with more customizable details, which provides more customizable functions, based on the traditional flutter ListTile. -version: 2.0.1 +version: 3.0.0 homepage: https://github.com/Playhi/list_tile_more_customizable environment: